com.ning.http.client.providers.grizzly.websocket

Class GrizzlyWebSocketAdapter

java.lang.Object

com.ning.http.client.providers.grizzly.websocket.GrizzlyWebSocketAdapter

All Implemented Interfaces:

WebSocket, Closeable, AutoCloseable

public final class GrizzlyWebSocketAdapter
extends Object
implements WebSocket

Grizzly AHC WebSocket adapter.

Method Summary

Modifier and Type	Method and Description
WebSocket	addWebSocketListener(WebSocketListener l) Add a WebSocketListener
void	close() Close the WebSocket.
CompletableFuture<org.glassfish.grizzly.websockets.DataFrame>	close(int code, String reason)
CompletableFuture<org.glassfish.grizzly.websockets.DataFrame>	completableSend(byte[] message)
CompletableFuture<org.glassfish.grizzly.websockets.DataFrame>	completableSend(String message)
CompletableFuture<org.glassfish.grizzly.websockets.DataFrame>	completableStream(byte[] fragment, boolean last)
CompletableFuture<org.glassfish.grizzly.websockets.DataFrame>	completableStream(byte[] fragment, int offset, int len, boolean last)
CompletableFuture<org.glassfish.grizzly.websockets.DataFrame>	completableStream(String fragment, boolean last)
org.glassfish.grizzly.websockets.WebSocket	getGrizzlyDelegate()
org.glassfish.grizzly.websockets.WebSocket	getGrizzlyWebSocket()
boolean	isOpen() Returns true if the WebSocket is open/connected.
static GrizzlyWebSocketAdapter	newInstance(AsyncHttpProviderConfig<?,?> config, org.glassfish.grizzly.websockets.ProtocolHandler protocolHandler) Create new GrizzlyWebSocketAdapter instance.
WebSocket	removeWebSocketListener(WebSocketListener l) Add a WebSocketListener
WebSocket	sendMessage(byte[] message) Send a byte message.
WebSocket	sendMessage(String message) Send a text message
WebSocket	sendPing(byte[] payload) Send a ping with an optional payload (limited to 125 bytes or less).
WebSocket	sendPong(byte[] payload) Send a ping with an optional payload (limited to 125 bytes or less).
WebSocket	stream(byte[] fragment, boolean last) Allows streaming of multiple binary fragments.
WebSocket	stream(byte[] fragment, int offset, int len, boolean last) Allows streaming of multiple binary fragments.
WebSocket	stream(String fragment, boolean last) Allows streaming of multiple text fragments.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

newInstance

public static GrizzlyWebSocketAdapter newInstance(AsyncHttpProviderConfig<?,?> config,
                                                  org.glassfish.grizzly.websockets.ProtocolHandler protocolHandler)

Create new GrizzlyWebSocketAdapter instance.

Parameters:

config -

protocolHandler -

Returns:

GrizzlyWebSocketAdapter

getGrizzlyWebSocket

public org.glassfish.grizzly.websockets.WebSocket getGrizzlyWebSocket()

sendMessage

public WebSocket sendMessage(byte[] message)

Description copied from interface: WebSocket

Send a byte message.

Specified by:

sendMessage in interface WebSocket

Parameters:

message - a byte message

Returns:

this

completableSend

public CompletableFuture<org.glassfish.grizzly.websockets.DataFrame> completableSend(byte[] message)

Specified by:

completableSend in interface WebSocket

stream

public WebSocket stream(byte[] fragment,
                        boolean last)

Description copied from interface: WebSocket

Allows streaming of multiple binary fragments.

Specified by:

stream in interface WebSocket

Parameters:

fragment - binary fragment.

last - flag indicating whether or not this is the last fragment.

Returns:

this.

completableStream

public CompletableFuture<org.glassfish.grizzly.websockets.DataFrame> completableStream(byte[] fragment,
                                                                                       boolean last)

Specified by:

completableStream in interface WebSocket

stream

public WebSocket stream(byte[] fragment,
                        int offset,
                        int len,
                        boolean last)

Description copied from interface: WebSocket

Allows streaming of multiple binary fragments.

Specified by:

stream in interface WebSocket

Parameters:

fragment - binary fragment.

offset - starting offset.

len - length.

last - flag indicating whether or not this is the last fragment.

Returns:

this.

completableStream

public CompletableFuture<org.glassfish.grizzly.websockets.DataFrame> completableStream(byte[] fragment,
                                                                                       int offset,
                                                                                       int len,
                                                                                       boolean last)

Specified by:

completableStream in interface WebSocket

sendMessage

public WebSocket sendMessage(String message)

Description copied from interface: WebSocket

Send a text message

Specified by:

sendMessage in interface WebSocket

Parameters:

message - a text message

Returns:

this.

completableSend

public CompletableFuture<org.glassfish.grizzly.websockets.DataFrame> completableSend(String message)

Specified by:

completableSend in interface WebSocket

stream

public WebSocket stream(String fragment,
                        boolean last)

Description copied from interface: WebSocket

Allows streaming of multiple text fragments.

Specified by:

stream in interface WebSocket

Parameters:

fragment - text fragment.

last - flag indicating whether or not this is the last fragment.

Returns:

this.

completableStream

public CompletableFuture<org.glassfish.grizzly.websockets.DataFrame> completableStream(String fragment,
                                                                                       boolean last)

Specified by:

completableStream in interface WebSocket

sendPing

public WebSocket sendPing(byte[] payload)

Description copied from interface: WebSocket

Send a ping with an optional payload (limited to 125 bytes or less).

Specified by:

sendPing in interface WebSocket

Parameters:

payload - the ping payload.

Returns:

this.

sendPong

public WebSocket sendPong(byte[] payload)

Description copied from interface: WebSocket

Send a ping with an optional payload (limited to 125 bytes or less).

Specified by:

sendPong in interface WebSocket

Parameters:

payload - the pong payload.

Returns:

this.

addWebSocketListener

public WebSocket addWebSocketListener(WebSocketListener l)

Description copied from interface: WebSocket

Add a WebSocketListener

Specified by:

addWebSocketListener in interface WebSocket

Parameters:

l - a WebSocketListener

Returns:

this

removeWebSocketListener

public WebSocket removeWebSocketListener(WebSocketListener l)

Description copied from interface: WebSocket

Add a WebSocketListener

Specified by:

removeWebSocketListener in interface WebSocket

Parameters:

l - a WebSocketListener

Returns:

this

isOpen

public boolean isOpen()

Description copied from interface: WebSocket

Returns true if the WebSocket is open/connected.

Specified by:

isOpen in interface WebSocket

Returns:

true if the WebSocket is open/connected.

close

public void close()

Description copied from interface: WebSocket

Close the WebSocket.

Specified by:

close in interface WebSocket

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

close

public CompletableFuture<org.glassfish.grizzly.websockets.DataFrame> close(int code,
                                                                           String reason)

Specified by:

close in interface WebSocket

getGrizzlyDelegate

public org.glassfish.grizzly.websockets.WebSocket getGrizzlyDelegate()