org.webbitserver
Interface WebSocketConnection

All Superinterfaces:

DataHolder, Executor, HttpConnection

All Known Implementing Classes:

NettyWebSocketConnection, StubConnection, WebSocketConnectionWrapper

public interface WebSocketConnection
extends HttpConnection

Method Summary

WebSocketConnection	close()
WebSocketConnection	data(String key, Object value) Store data value by key.
WebSocketConnection	ping(byte[] message) Sends a ping frame
WebSocketConnection	pong(byte[] message) Sends a pong frame
WebSocketConnection	send(byte[] message) Sends a binary frame
WebSocketConnection	send(byte[] message, int offset, int length) Sends a binary frame
WebSocketConnection	send(String message) Sends a text frame
String	version()

Methods inherited from interface org.webbitserver.HttpConnection

handlerExecutor, httpRequest

Methods inherited from interface java.util.concurrent.Executor

execute

Methods inherited from interface org.webbitserver.DataHolder

data, data, dataKeys

Method Detail

send

WebSocketConnection send(String message)

Sends a text frame

Parameters:

message - frame payload

Returns:

this

send

WebSocketConnection send(byte[] message)

Sends a binary frame

Parameters:

message - frame payload

Returns:

this

send

WebSocketConnection send(byte[] message,
                         int offset,
                         int length)

Sends a binary frame

Parameters:

message - frame payload

offset - The offset within the array of the first byte to be written; must be non-negative and no larger than message.length

length - The maximum number of bytes to be written to the given array; must be non-negative and no larger than message.length - offset

Returns:

this

ping

WebSocketConnection ping(byte[] message)

Sends a ping frame

Parameters:

message - the payload of the ping

Returns:

this

pong

WebSocketConnection pong(byte[] message)

Sends a pong frame

Parameters:

message - the payload of the ping

Returns:

this

version

String version()

Returns:

the WebSocket protocol version

close

WebSocketConnection close()

Specified by:

close in interface HttpConnection

data

WebSocketConnection data(String key,
                         Object value)

Description copied from interface: DataHolder

Store data value by key.

Specified by:

data in interface DataHolder

See Also:

DataHolder.data()