com.ning.http.client.ws

Interface WebSocket

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

GrizzlyWebSocketAdapter

public interface WebSocket
extends Closeable

A Websocket client

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[] message, 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)
boolean	isOpen() Returns true if the WebSocket is open/connected.
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.

Method Detail

sendMessage

WebSocket sendMessage(byte[] message)

Send a byte message.

Parameters:

message - a byte message

Returns:

this

completableSend

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

stream

WebSocket stream(byte[] fragment,
                 boolean last)

Allows streaming of multiple binary fragments.

Parameters:

fragment - binary fragment.

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

Returns:

this.

completableStream

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

stream

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

Allows streaming of multiple binary fragments.

Parameters:

fragment - binary fragment.

offset - starting offset.

len - length.

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

Returns:

this.

completableStream

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

sendMessage

WebSocket sendMessage(String message)

Send a text message

Parameters:

message - a text message

Returns:

this.

completableSend

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

stream

WebSocket stream(String fragment,
                 boolean last)

Allows streaming of multiple text fragments.

Parameters:

fragment - text fragment.

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

Returns:

this.

completableStream

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

sendPing

WebSocket sendPing(byte[] payload)

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

Parameters:

payload - the ping payload.

Returns:

this.

sendPong

WebSocket sendPong(byte[] payload)

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

Parameters:

payload - the pong payload.

Returns:

this.

addWebSocketListener

WebSocket addWebSocketListener(WebSocketListener l)

Add a WebSocketListener

Parameters:

l - a WebSocketListener

Returns:

this

removeWebSocketListener

WebSocket removeWebSocketListener(WebSocketListener l)

Add a WebSocketListener

Parameters:

l - a WebSocketListener

Returns:

this

isOpen

boolean isOpen()

Returns true if the WebSocket is open/connected.

Returns:

true if the WebSocket is open/connected.

close

void close()

Close the WebSocket.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

close

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