Java-WebSocket 1.6.0 · org.java_websocket.WebSocketImpl

Modifier and Type	Field and Description
private Object	attachment Attribute to store connection attachment
private ByteChannel	channel the possibly wrapped channel object whose selection is controlled by `key`
private Integer	closecode
private Boolean	closedremotely
private String	closemessage
public static final int	DEFAULT_PORT The default port of WebSockets, as defined in the spec.
public static final int	DEFAULT_WSS_PORT The default wss port of WebSockets, as defined in the spec.
private Draft	draft The draft which is used by this websocket
private boolean	flushandclosestate When true no further frames may be submitted to be sent
private ClientHandshake	handshakerequest stores the handshake sent by this websocket ( Role.CLIENT only )
public final BlockingQueue<ByteBuffer>	inQueue Queue of buffers that need to be processed
private SelectionKey	key
private List<Draft>	knownDrafts A list of drafts available for this websocket
private long	lastPong Attribute, when the last pong was received
private final Logger	log Logger instance
public final BlockingQueue<ByteBuffer>	outQueue Queue of buffers that need to be sent to the client.
private volatile ReadyState	readyState The current state of the connection
private String	resourceDescriptor
private Role	role The role which this websocket takes in the connection
private final Object	synchronizeWriteObject Attribut to synchronize the write
private ByteBuffer	tmpHandshakeBytes the bytes of an incomplete received handshake
private WebSocketServer.WebSocketWorker	workerThread Helper variable meant to store the thread which ( exclusively ) triggers this objects decode method.
private final WebSocketListener	wsl The listener to notify of WebSocket events.

Access	Constructor and Description
public	WebSocketImpl(WebSocketListener The listener for this instance listener, List<Draft> The drafts which should be used drafts) Creates a websocket with server role
public	WebSocketImpl(WebSocketListener The listener for this instance listener, Draft The draft which should be used draft) creates a websocket with client role

Method Summary

Modifier and Type	Method and Description
public synchronized void	close(int code, String message, boolean remote)
public void	close(int code, String message) Implements org.java_websocket.WebSocket.close. sends the closing handshake.
public void	close(int code) Implements org.java_websocket.WebSocket.close. sends the closing handshake.
public void	close(InvalidDataException e)
public void	close() Implements org.java_websocket.WebSocket.close. Convenience function which behaves like close(CloseFrame.NORMAL)
public synchronized void	closeConnection(int the closing code code, String the closing message message, boolean Indicates who "generated" `code`. `true` means that this endpoint received the `code` from the other endpoint. false means this endpoint decided to send the given code, `remote` may also be true if this endpoint started the closing handshake since the other endpoint may not simply echo the `code` but close the connection the same time this endpoint does do but with an other `code`. remote) This will close the connection immediately without a proper close handshake.
protected void	closeConnection(int code, boolean remote)
public void	closeConnection()
public void	closeConnection(int code, String message) Implements org.java_websocket.WebSocket.closeConnection. This will close the connection immediately without a proper close handshake.
private void	closeConnectionDueToInternalServerError(RuntimeException the RuntimeException causing this problem exception) Close the connection if there was a server error by a RuntimeException
private void	closeConnectionDueToWrongHandshake(InvalidDataException the InvalidDataException causing this problem exception) Close the connection if the received handshake was not correct
public void	decode(ByteBuffer the ByteBuffer to decode socketBuffer) Method to decode the provided ByteBuffer
private void	decodeFrames(ByteBuffer socketBuffer)
private boolean	decodeHandshake(ByteBuffer socketBufferNew) Returns whether the handshake phase has is completed.
public void	eot()
public synchronized void	flushAndClose(int code, String message, boolean remote)
private ByteBuffer	Returns: the complete response as ByteBuffer generateHttpResponseDueToError(int the http error code errorCode) Generate a simple response for the corresponding endpoint to indicate some error
public <T> T	getAttachment() Implements org.java_websocket.WebSocket.getAttachment. Getter for the connection attachment.
public ByteChannel	getChannel()
public Draft	getDraft() Implements org.java_websocket.WebSocket.getDraft. Getter for the draft
pack-priv long	Returns: the timestamp for the last received pong getLastPong() Getter for the last pong received
public InetSocketAddress	getLocalSocketAddress() Implements org.java_websocket.WebSocket.getLocalSocketAddress. Returns the address of the endpoint this socket is bound to, or `null` if it is not bound.
public IProtocol	getProtocol() Implements org.java_websocket.WebSocket.getProtocol. Returns the used Sec-WebSocket-Protocol for this websocket connection
public ReadyState	getReadyState() Implements org.java_websocket.WebSocket.getReadyState. Retrieve the WebSocket 'ReadyState'.
public InetSocketAddress	getRemoteSocketAddress() Implements org.java_websocket.WebSocket.getRemoteSocketAddress. Returns the address of the endpoint this socket is connected to, or `null` if it is unconnected.
public String	getResourceDescriptor() Implements org.java_websocket.WebSocket.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.
public SelectionKey	Returns: the selection key of this implementation getSelectionKey()
public SSLSession	getSSLSession() Implements org.java_websocket.WebSocket.getSSLSession. Returns the ssl session of websocket, if ssl/wss is used for this instance.
public WebSocketListener	Returns: the websocket listener associated with this instance getWebSocketListener() Getter for the websocket listener
public WebSocketServer.WebSocketWorker	getWorkerThread()
public boolean	hasBufferedData() Implements org.java_websocket.WebSocket.hasBufferedData. Checks if the websocket has buffered data
public boolean	hasSSLSupport() Implements org.java_websocket.WebSocket.hasSSLSupport. Does this websocket use an encrypted (wss/ssl) or unencrypted (ws) connection
public boolean	isClosed() Implements org.java_websocket.WebSocket.isClosed. Is the websocket in the state CLOSED
public boolean	isClosing() Implements org.java_websocket.WebSocket.isClosing. Is the websocket in the state CLOSING
public boolean	isFlushAndClose() Implements org.java_websocket.WebSocket.isFlushAndClose. Returns true when no further frames may be submitted This happens before the socket connection is closed.
public boolean	isOpen() Implements org.java_websocket.WebSocket.isOpen. Is the websocket in the state OPEN
private void	open(Handshakedata d)
public void	send(String text) Implements org.java_websocket.WebSocket.send. Send Text data to the other end.
public void	send(ByteBuffer bytes) Implements org.java_websocket.WebSocket.send. Send Binary data (plain bytes) to the other end.
public void	send(byte[] bytes) Implements org.java_websocket.WebSocket.send. Send Binary data (plain bytes) to the other end.
private void	send(Collection<Framedata> frames)
public void	sendFragmentedFrame(Opcode op, ByteBuffer buffer, boolean fin) Implements org.java_websocket.WebSocket.sendFragmentedFrame. Allows to send continuous/fragmented frames conveniently.
public void	sendFrame(Collection<Framedata> frames) Implements org.java_websocket.WebSocket.sendFrame. Send a collection of frames to the other end
public void	sendFrame(Framedata framedata) Implements org.java_websocket.WebSocket.sendFrame. Send a frame to the other end
public void	sendPing() Implements org.java_websocket.WebSocket.sendPing. Send a ping to the other end
public <T> void	setAttachment(T attachment) Implements org.java_websocket.WebSocket.setAttachment. Setter for an attachment on the socket connection.
public void	setChannel(ByteChannel channel)
public void	setSelectionKey(SelectionKey the selection key of this implementation key)
public void	setWorkerThread(WebSocketServer.WebSocketWorker workerThread)
public void	startHandshake(ClientHandshakeBuilder handshakedata)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	updateLastPong() Update the timestamp when the last pong was received
private void	write(ByteBuffer buf)
private void	write(List<ByteBuffer> the list of bytebuffer bufs) Write a list of bytebuffer (frames in binary form) into the outgoing queue

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

attachment	back to summary
private Object attachment Attribute to store connection attachment Since 1.3.7

attachment

back to summary

private Object attachment

Attribute to store connection attachment

Since: 1.3.7

channel	back to summary
private ByteChannel channel the possibly wrapped channel object whose selection is controlled by `key`

closecode	back to summary
private Integer closecode

closedremotely	back to summary
private Boolean closedremotely

closemessage	back to summary
private String closemessage

DEFAULT_PORT	back to summary
public 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.

DEFAULT_WSS_PORT	back to summary
public static final int DEFAULT_WSS_PORT The default wss port of WebSockets, as defined in the spec. If the nullary constructor is used, DEFAULT_WSS_PORT will be the port the WebSocketServer is binded to. Note that ports under 1024 usually require root permissions.

draft	back to summary
private Draft draft The draft which is used by this websocket

flushandclosestate	back to summary
private boolean flushandclosestate When true no further frames may be submitted to be sent

handshakerequest	back to summary
private ClientHandshake handshakerequest stores the handshake sent by this websocket ( Role.CLIENT only )

inQueue	back to summary
public final BlockingQueue<ByteBuffer> inQueue Queue of buffers that need to be processed

key	back to summary
private SelectionKey key

knownDrafts	back to summary
private List<Draft> knownDrafts A list of drafts available for this websocket

lastPong	back to summary
private long lastPong Attribute, when the last pong was received

log	back to summary
private final Logger log Logger instance Since 1.4.0

log

back to summary

private final Logger log

Logger instance

Since: 1.4.0

outQueue	back to summary
public final BlockingQueue<ByteBuffer> outQueue Queue of buffers that need to be sent to the client.

readyState	back to summary
private volatile ReadyState readyState The current state of the connection

resourceDescriptor	back to summary
private String resourceDescriptor

role	back to summary
private Role role The role which this websocket takes in the connection

synchronizeWriteObject	back to summary
private final Object synchronizeWriteObject Attribut to synchronize the write

tmpHandshakeBytes	back to summary
private ByteBuffer tmpHandshakeBytes the bytes of an incomplete received handshake

workerThread	back to summary
private WebSocketServer.WebSocketWorker workerThread Helper variable meant to store the thread which ( exclusively ) triggers this objects decode method.

wsl	back to summary
private final WebSocketListener wsl The listener to notify of WebSocket events.

Constructor Detail

WebSocketImpl	back to summary
public WebSocketImpl(WebSocketListener listener, List<Draft> drafts) Creates a websocket with server role Parameters listener:WebSocketListener The listener for this instance drafts:List<Draft> The drafts which should be used

WebSocketImpl

back to summary

public WebSocketImpl(WebSocketListener listener, List<Draft> drafts)

Creates a websocket with server role

Parameters

listener:WebSocketListener: The listener for this instance
drafts:List<Draft>: The drafts which should be used

WebSocketImpl	back to summary
public WebSocketImpl(WebSocketListener listener, Draft draft) creates a websocket with client role Parameters listener:WebSocketListener The listener for this instance draft:Draft The draft which should be used

WebSocketImpl

back to summary

public WebSocketImpl(WebSocketListener listener, Draft draft)

creates a websocket with client role

Parameters

listener:WebSocketListener: The listener for this instance
draft:Draft: The draft which should be used

Method Detail

close	back to summary
public synchronized void close(int code, String message, boolean remote)

close	back to summary
public void close(int code, String message) Implements org.java_websocket.WebSocket.close. Doc from org.java_websocket.WebSocket.close. sends the closing handshake. may be send in response to an other handshake. Annotations @Override

back to summary

public void close(int code, String message)

Implements org.java_websocket.WebSocket.close.

Doc from org.java_websocket.WebSocket.close.

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

Annotations

@Override

close	back to summary
public void close(int code) Implements org.java_websocket.WebSocket.close. Doc from org.java_websocket.WebSocket.close. sends the closing handshake. may be send in response to an other handshake. Annotations @Override

back to summary

public void close(int code)

Implements org.java_websocket.WebSocket.close.

Doc from org.java_websocket.WebSocket.close.

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

Annotations

@Override

close	back to summary
public void close(InvalidDataException e)

close	back to summary
public void close() Implements org.java_websocket.WebSocket.close. Doc from org.java_websocket.WebSocket.close. Convenience function which behaves like close(CloseFrame.NORMAL) Annotations @Override

back to summary

public void close()

Implements org.java_websocket.WebSocket.close.

Doc from org.java_websocket.WebSocket.close.

Convenience function which behaves like close(CloseFrame.NORMAL)

Annotations

@Override

closeConnection back to summary

closeConnection	back to summary
public synchronized void closeConnection(int code, String message, boolean remote) This will close the connection immediately without a proper close handshake. The code and the message therefore won't be transferred over the wire also they will be forwarded to onClose/onWebsocketClose. Parameters code:int the closing code message:String the closing message remote:boolean Indicates who "generated" `code`. `true` means that this endpoint received the `code` from the other endpoint. false means this endpoint decided to send the given code, `remote` may also be true if this endpoint started the closing handshake since the other endpoint may not simply echo the `code` but close the connection the same time this endpoint does do but with an other `code`.

public synchronized void closeConnection(int code, String message, boolean remote)

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

Parameters

code:int: the closing code
message:String: the closing message
remote:boolean: Indicates who "generated" code.
true means that this endpoint received the code from the other endpoint.
false means this endpoint decided to send the given code,
remote may also be true if this endpoint started the closing handshake since the other endpoint may not simply echo the code but close the connection the same time this endpoint does do but with an other code.

closeConnection	back to summary
protected void closeConnection(int code, boolean remote)

closeConnection	back to summary
public void closeConnection()

closeConnection	back to summary
public void closeConnection(int code, String message) Implements org.java_websocket.WebSocket.closeConnection. Doc from org.java_websocket.WebSocket.closeConnection. This will close the connection immediately without a proper close handshake. The code and the message therefore won't be transferred over the wire also they will be forwarded to onClose/onWebsocketClose.

closeConnection

back to summary

public void closeConnection(int code, String message)

Implements org.java_websocket.WebSocket.closeConnection.

Doc from org.java_websocket.WebSocket.closeConnection.

closeConnectionDueToInternalServerError	back to summary
private void closeConnectionDueToInternalServerError(RuntimeException exception) Close the connection if there was a server error by a RuntimeException Parameters exception:RuntimeException the RuntimeException causing this problem

closeConnectionDueToInternalServerError

back to summary

private void closeConnectionDueToInternalServerError(RuntimeException exception)

Close the connection if there was a server error by a RuntimeException

Parameters

exception:RuntimeException: the RuntimeException causing this problem

closeConnectionDueToWrongHandshake	back to summary
private void closeConnectionDueToWrongHandshake(InvalidDataException exception) Close the connection if the received handshake was not correct Parameters exception:InvalidDataException the InvalidDataException causing this problem

closeConnectionDueToWrongHandshake

back to summary

private void closeConnectionDueToWrongHandshake(InvalidDataException exception)

Close the connection if the received handshake was not correct

Parameters

exception:InvalidDataException: the InvalidDataException causing this problem

decode	back to summary
public void decode(ByteBuffer socketBuffer) Method to decode the provided ByteBuffer Parameters socketBuffer:ByteBuffer the ByteBuffer to decode

decode

back to summary

public void decode(ByteBuffer socketBuffer)

Method to decode the provided ByteBuffer

Parameters

socketBuffer:ByteBuffer: the ByteBuffer to decode

decodeFrames	back to summary
private void decodeFrames(ByteBuffer socketBuffer)

decodeHandshake	back to summary
private boolean decodeHandshake(ByteBuffer socketBufferNew) Returns whether the handshake phase has is completed. In case of a broken handshake this will be never the case.

eot	back to summary
public void eot()

flushAndClose	back to summary
public synchronized void flushAndClose(int code, String message, boolean remote)

generateHttpResponseDueToError	back to summary
private ByteBuffer generateHttpResponseDueToError(int errorCode) Generate a simple response for the corresponding endpoint to indicate some error Parameters errorCode:int the http error code Returns:ByteBuffer the complete response as ByteBuffer

generateHttpResponseDueToError

back to summary

private ByteBuffer generateHttpResponseDueToError(int errorCode)

Generate a simple response for the corresponding endpoint to indicate some error

Parameters

errorCode:int: the http error code

Returns:ByteBuffer

the complete response as ByteBuffer

getAttachment	back to summary
public <T> T getAttachment() Implements org.java_websocket.WebSocket.getAttachment. Doc from org.java_websocket.WebSocket.getAttachment. Getter for the connection attachment. Annotations @Override @SuppressWarnings:unchecked

getAttachment

back to summary

public <T> T getAttachment()

Implements org.java_websocket.WebSocket.getAttachment.

Doc from org.java_websocket.WebSocket.getAttachment.

Getter for the connection attachment.

Annotations

@Override
@SuppressWarnings:unchecked

getChannel	back to summary
public ByteChannel getChannel()

getDraft	back to summary
public Draft getDraft() Implements org.java_websocket.WebSocket.getDraft. Doc from org.java_websocket.WebSocket.getDraft. Getter for the draft Annotations @Override

getDraft

back to summary

public Draft getDraft()

Implements org.java_websocket.WebSocket.getDraft.

Doc from org.java_websocket.WebSocket.getDraft.

Getter for the draft

Annotations

@Override

getLastPong	back to summary
pack-priv long getLastPong() Getter for the last pong received Returns:long the timestamp for the last received pong

getLastPong

back to summary

pack-priv long getLastPong()

Getter for the last pong received

Returns:long: the timestamp for the last received pong

getLocalSocketAddress back to summary

getLocalSocketAddress	back to summary
public InetSocketAddress getLocalSocketAddress() Implements org.java_websocket.WebSocket.getLocalSocketAddress. Doc from org.java_websocket.WebSocket.getLocalSocketAddress. Returns the address of the endpoint this socket is bound to, or `null` if it is not bound. Annotations @Override

public InetSocketAddress getLocalSocketAddress()

Implements org.java_websocket.WebSocket.getLocalSocketAddress.

Doc from org.java_websocket.WebSocket.getLocalSocketAddress.

Returns the address of the endpoint this socket is bound to, or null if it is not bound.

Annotations

@Override

getProtocol

back to summary

public IProtocol getProtocol()

Implements org.java_websocket.WebSocket.getProtocol.

Doc from org.java_websocket.WebSocket.getProtocol.

Returns the used Sec-WebSocket-Protocol for this websocket connection

Annotations

@Override

getReadyState

back to summary

public ReadyState getReadyState()

Implements org.java_websocket.WebSocket.getReadyState.

Doc from org.java_websocket.WebSocket.getReadyState.

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

Annotations

@Override

getRemoteSocketAddress back to summary

public InetSocketAddress getRemoteSocketAddress()

Implements org.java_websocket.WebSocket.getRemoteSocketAddress.

Doc from org.java_websocket.WebSocket.getRemoteSocketAddress.

Returns the address of the endpoint this socket is connected to, or null if it is unconnected.

Annotations

@Override

getResourceDescriptor

back to summary

public String getResourceDescriptor()

Implements org.java_websocket.WebSocket.getResourceDescriptor.

Doc from org.java_websocket.WebSocket.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.

Annotations

@Override

getSelectionKey	back to summary
public SelectionKey getSelectionKey() Returns:SelectionKey the selection key of this implementation

getSSLSession

back to summary

public SSLSession getSSLSession()

Implements org.java_websocket.WebSocket.getSSLSession.

Doc from org.java_websocket.WebSocket.getSSLSession.

Returns the ssl session of websocket, if ssl/wss is used for this instance.

Annotations

@Override

getWebSocketListener

back to summary

public WebSocketListener getWebSocketListener()

Getter for the websocket listener

Returns:WebSocketListener: the websocket listener associated with this instance

getWorkerThread	back to summary
public WebSocketServer.WebSocketWorker getWorkerThread()

hasBufferedData

back to summary

public boolean hasBufferedData()

Implements org.java_websocket.WebSocket.hasBufferedData.

Doc from org.java_websocket.WebSocket.hasBufferedData.

Checks if the websocket has buffered data

Annotations

@Override

hasSSLSupport

back to summary

public boolean hasSSLSupport()

Implements org.java_websocket.WebSocket.hasSSLSupport.

Doc from org.java_websocket.WebSocket.hasSSLSupport.

Does this websocket use an encrypted (wss/ssl) or unencrypted (ws) connection

Annotations

@Override

isClosed

back to summary

public boolean isClosed()

Implements org.java_websocket.WebSocket.isClosed.

Doc from org.java_websocket.WebSocket.isClosed.

Is the websocket in the state CLOSED

Annotations

@Override

isClosing

back to summary

public boolean isClosing()

Implements org.java_websocket.WebSocket.isClosing.

Doc from org.java_websocket.WebSocket.isClosing.

Is the websocket in the state CLOSING

Annotations

@Override

isFlushAndClose

back to summary

public boolean isFlushAndClose()

Implements org.java_websocket.WebSocket.isFlushAndClose.

Doc from org.java_websocket.WebSocket.isFlushAndClose.

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

Annotations

@Override

isOpen

back to summary

public boolean isOpen()

Implements org.java_websocket.WebSocket.isOpen.

Doc from org.java_websocket.WebSocket.isOpen.

Is the websocket in the state OPEN

Annotations

@Override

open	back to summary
private void open(Handshakedata d)

send

back to summary

public void send(String text)

Implements org.java_websocket.WebSocket.send.

Send Text data to the other end.

Annotations

@Override

Exceptions

WebsocketNotConnectedException:: websocket is not yet connected

send

back to summary

public void send(ByteBuffer bytes)

Implements org.java_websocket.WebSocket.send.

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

Annotations

@Override

Exceptions

IllegalArgumentException:: the data is null
WebsocketNotConnectedException:: websocket is not yet connected

send

back to summary

public void send(byte[] bytes)

Implements org.java_websocket.WebSocket.send.

Doc from org.java_websocket.WebSocket.send.

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

Annotations

@Override

send	back to summary
private void send(Collection<Framedata> frames)

sendFragmentedFrame

back to summary

public void sendFragmentedFrame(Opcode op, ByteBuffer buffer, boolean fin)

Implements org.java_websocket.WebSocket.sendFragmentedFrame.

Doc from org.java_websocket.WebSocket.sendFragmentedFrame.

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.

Annotations