com.pusher.java_websocket

Interface WebSocket

All Known Implementing Classes:

WebSocketClient, WebSocketImpl

public interface WebSocket

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	WebSocket.READYSTATE
static class	WebSocket.Role

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PORT The default port of WebSockets, as defined in the spec.
static int	DEFAULT_WSS_PORT

Method Summary

Modifier and Type	Method and Description
void	close() Convenience function which behaves like close(CloseFrame.NORMAL)
void	close(int code)
void	close(int code, java.lang.String message) sends the closing handshake.
void	closeConnection(int code, java.lang.String message) This will close the connection immediately without a proper close handshake.
Draft	getDraft()
java.net.InetSocketAddress	getLocalSocketAddress()
WebSocket.READYSTATE	getReadyState() Retrieve the WebSocket 'readyState'.
java.net.InetSocketAddress	getRemoteSocketAddress()
java.lang.String	getResourceDescriptor() Returns the HTTP Request-URI as defined by http://tools.ietf.org/html/rfc2616#section-5.1.2 If the opening handshake has not yet happened it will return null.
boolean	hasBufferedData()
boolean	isClosed() Returns whether the close handshake has been completed and the socket is closed.
boolean	isClosing()
boolean	isConnecting()
boolean	isFlushAndClose() Returns true when no further frames may be submitted This happens before the socket connection is closed.
boolean	isOpen()
void	send(byte[] bytes)
void	send(java.nio.ByteBuffer bytes) Send Binary data (plain bytes) to the other end.
void	send(java.lang.String text) Send Text data to the other end.
void	sendFragmentedFrame(Framedata.Opcode op, java.nio.ByteBuffer buffer, boolean fin) Allows to send continuous/fragmented frames conveniently.
void	sendFrame(Framedata framedata)

Field Detail

DEFAULT_PORT

static final int DEFAULT_PORT

The default port of WebSockets, as defined in the spec. If the nullary constructor is used, DEFAULT_PORT will be the port the WebSocketServer is binded to. Note that ports under 1024 usually require root permissions.

See Also:

Constant Field Values

DEFAULT_WSS_PORT

static final int DEFAULT_WSS_PORT

See Also:

Constant Field Values

Method Detail

close

void close(int code,
           java.lang.String message)

sends the closing handshake. may be send in response to an other handshake.

close

void close(int code)

close

void close()

Convenience function which behaves like close(CloseFrame.NORMAL)

closeConnection

void closeConnection(int code,
                     java.lang.String message)

This will close the connection immediately without a proper close handshake. The code and the message therefore won't be transfered over the wire also they will be forwarded to onClose/onWebsocketClose.

send

void send(java.lang.String text)
   throws java.nio.channels.NotYetConnectedException

Send Text data to the other end.

Throws:

java.lang.IllegalArgumentException

java.nio.channels.NotYetConnectedException

send

void send(java.nio.ByteBuffer bytes)
   throws java.lang.IllegalArgumentException,
          java.nio.channels.NotYetConnectedException

Send Binary data (plain bytes) to the other end.

Throws:

java.lang.IllegalArgumentException

java.nio.channels.NotYetConnectedException

send

void send(byte[] bytes)
   throws java.lang.IllegalArgumentException,
          java.nio.channels.NotYetConnectedException

Throws:

java.lang.IllegalArgumentException

java.nio.channels.NotYetConnectedException

sendFrame

void sendFrame(Framedata framedata)

sendFragmentedFrame

void sendFragmentedFrame(Framedata.Opcode op,
                         java.nio.ByteBuffer buffer,
                         boolean fin)

Allows to send continuous/fragmented frames conveniently.
For more into on this frame type see http://tools.ietf.org/html/rfc6455#section-5.4
If the first frame you send is also the last then it is not a fragmented frame and will received via onMessage instead of onFragmented even though it was send by this method.

Parameters:

op - This is only important for the first frame in the sequence. Opcode.TEXT, Opcode.BINARY are allowed.

buffer - The buffer which contains the payload. It may have no bytes remaining.

fin - true means the current frame is the last in the sequence.

hasBufferedData

boolean hasBufferedData()

getRemoteSocketAddress

java.net.InetSocketAddress getRemoteSocketAddress()

Returns:

never returns null

getLocalSocketAddress

java.net.InetSocketAddress getLocalSocketAddress()

Returns:

never returns null

isConnecting

boolean isConnecting()

isOpen

boolean isOpen()

isClosing

boolean isClosing()

isFlushAndClose

boolean isFlushAndClose()

Returns true when no further frames may be submitted
This happens before the socket connection is closed.

isClosed

boolean isClosed()

Returns whether the close handshake has been completed and the socket is closed.

getDraft

Draft getDraft()

getReadyState

WebSocket.READYSTATE getReadyState()

Retrieve the WebSocket 'readyState'. This represents the state of the connection. It returns a numerical value, as per W3C WebSockets specs.

Returns:

Returns '0 = CONNECTING', '1 = OPEN', '2 = CLOSING' or '3 = CLOSED'

getResourceDescriptor

java.lang.String getResourceDescriptor()

Returns the HTTP Request-URI as defined by http://tools.ietf.org/html/rfc2616#section-5.1.2
If the opening handshake has not yet happened it will return null.