com.ning.http.client.websocket
Interface WebSocket

All Superinterfaces:

Closeable

All Known Implementing Classes:

NettyWebSocket

public interface WebSocket
extends Closeable

A Websocket client

Method Summary

WebSocket	addWebSocketListener(WebSocketListener l) Add a WebSocketListener
void	close() Close the WebSocket.
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	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	sendTextMessage(String message) Send a text message
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	streamText(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

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.

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.

sendTextMessage

WebSocket sendTextMessage(String message)

Send a text message

Parameters:

message - a text message

Returns:

this.

streamText

WebSocket streamText(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.

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 Closeable