Package org.threadly.litesockets.client.websocket

Class WSClient

java.lang.Object

org.threadly.litesockets.client.websocket.WSClient

All Implemented Interfaces:

StreamingClient

public class WSClient
extends java.lang.Object
implements StreamingClient

This is a Wrapper around HTTPStreamClient that simplifies it for use with WebSockets.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WSClient.WebSocketDataReader	This is the Read callback used for WSClient.

Field Summary

Fields

Modifier and Type	Field	Description
static org.threadly.litesockets.protocols.http.request.HTTPRequest	DEFAULT_WS_REQUEST
static org.threadly.litesockets.protocols.http.response.HTTPResponse	DEFAULT_WS_RESPONSE
static int	WS_PORT
static java.lang.String	WS_STRING
static int	WSS_PORT
static java.lang.String	WSS_STRING

Constructor Summary

Constructors

Constructor	Description
WSClient(org.threadly.litesockets.SocketExecuter se, java.lang.String host, int port)	Creates a websocket connection to the specified host and port, using the provided SocketExecuter.
WSClient(org.threadly.litesockets.SocketExecuter se, java.net.URI uri)	Creates a websocket connection to the specified URI.
WSClient(org.threadly.litesockets.TCPClient client)	This takes over an existing TCPClient to do websocket communications.

Method Summary

Modifier and Type	Method	Description
void	addCloseListener(java.lang.Runnable cl)	Sets a runnable to be ran once this connection is closed.
void	close()	This will close the client.
org.threadly.concurrent.future.ListenableFuture<java.lang.Boolean>	connect()	This is called to connect this client to the server.
void	doPingAutoPong(boolean doPings)	This sets whether or not the WebSocketClient will auto replay to websocket pings.
void	enableSSL()	This is called to enable ssl on this connection.
void	enableSSL(javax.net.ssl.SSLEngine ssle)	This is called to enable ssl on this connection.
java.util.concurrent.Executor	getClientsThreadExecutor()	Gets the Executor for this client.
boolean	getDefaultMask()	Returns the value of the default mask set on this WebSocketClient.
org.threadly.litesockets.protocols.websocket.WSOPCode	getDefaultOpCode()	Returns the current default WSOPCode in use by this connection.
org.threadly.concurrent.future.ListenableFuture<?>	getLastWriteFuture()
boolean	getPingAutoReply()	Returns the current value set for pingAuto reply.
boolean	isConnected()
void	setConnectionTimeout(int timeout)	This sets the timeout on the connection to the remote host.
void	setDefaultMask(boolean mask)	This sets whether or not the default write(ByteBuffer) should mask the data that is being sent.
void	setDefaultOpCode(org.threadly.litesockets.protocols.websocket.WSOPCode wsoc)	Sets the default WSOPCode to use when calling write(ByteBuffer).
void	setExtraHeader(java.lang.String key, java.lang.String value)	This allows you to set extra headers or change any header on the HTTP upgrade request sent to the server.
void	setRequestPath(java.lang.String path)	This allows you to set the path used in the initial HTTP upgrade Request sent to the WebSocket server.
void	setRequestResponseHeaders(org.threadly.litesockets.protocols.http.request.HTTPRequest httpRequest, org.threadly.litesockets.protocols.http.response.HTTPResponse httpResponse, boolean writeRequest)	Sets the HTTPRequest and HTTPResponse allowing the streaming client to start streaming w/o sending these in itself.
void	setWebSocketDataReader(WSClient.WebSocketDataReader reader)	Sets the WSClient.WebSocketDataReader for this client.
void	setWebSocketKey(java.lang.String key)	This allows you to set the websocket key used in the initial HTTP upgrade request sent to the server.
void	setWebSocketVersion(int version)	This allows you to set the websocket version used in the initial HTTP upgrade request.
org.threadly.concurrent.future.ListenableFuture<?>	write(java.nio.ByteBuffer bb)	This performs a write to the connection.
org.threadly.concurrent.future.ListenableFuture<?>	write(java.nio.ByteBuffer bb, org.threadly.litesockets.protocols.websocket.WSOPCode opCode, boolean mask)	This performs a write to the websocket connection.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_WS_RESPONSE

public static final org.threadly.litesockets.protocols.http.response.HTTPResponse DEFAULT_WS_RESPONSE

DEFAULT_WS_REQUEST

public static final org.threadly.litesockets.protocols.http.request.HTTPRequest DEFAULT_WS_REQUEST

WSS_STRING

public static final java.lang.String WSS_STRING

See Also:

Constant Field Values

WS_STRING

public static final java.lang.String WS_STRING

See Also:

Constant Field Values

WSS_PORT

public static final int WSS_PORT

See Also:

Constant Field Values

WS_PORT

public static final int WS_PORT

See Also:

Constant Field Values

Constructor Detail

WSClient

public WSClient(org.threadly.litesockets.TCPClient client)

This takes over an existing TCPClient to do websocket communications.

Parameters:

client - the TCPClient to use for this connection.

WSClient

public WSClient(org.threadly.litesockets.SocketExecuter se,
                java.net.URI uri)
         throws java.io.IOException

Creates a websocket connection to the specified URI.

Parameters:

se - the SocketExecuter to use for creating this connection.

uri - the URI to use for setting up this connection.

Throws:

java.io.IOException - this is thrown if there are any problems creating the TCP socket for this connection.

WSClient

public WSClient(org.threadly.litesockets.SocketExecuter se,
                java.lang.String host,
                int port)
         throws java.io.IOException

Creates a websocket connection to the specified host and port, using the provided SocketExecuter.

Parameters:

se - the SocketExecuter to use for this connection.

host - the host string or IP to make the connection too.

port - the port on the host to connect too.

Throws:

java.io.IOException - this is thrown if there are any problems creating the tcp socket for this connection.

Method Detail

enableSSL

public void enableSSL()

Description copied from interface: StreamingClient

This is called to enable ssl on this connection. This can only be done before connect is called. This is the default ssl handler meaning there is no server side certificate validation done.

Specified by:

enableSSL in interface StreamingClient

enableSSL

public void enableSSL(javax.net.ssl.SSLEngine ssle)

Description copied from interface: StreamingClient

This is called to enable ssl on this connection. This can only be done before connect is called. This method allows you to set the SSLEngine to use for this connection allow you to validate the certificates if needed.

Specified by:

enableSSL in interface StreamingClient

Parameters:

ssle - the SSLEngine to use for this connection.

setConnectionTimeout

public void setConnectionTimeout(int timeout)

Description copied from interface: StreamingClient

This sets the timeout on the connection to the remote host. This can only be set before the StreamingClient.connect() is called.

Specified by:

setConnectionTimeout in interface StreamingClient

Parameters:

timeout - the timeout in milliseconds to use for this connection.

setDefaultMask

public void setDefaultMask(boolean mask)

This sets whether or not the default write(ByteBuffer) should mask the data that is being sent.

Parameters:

mask - true to set the default to mask the sent data, false to not mask the data.

getDefaultMask

public boolean getDefaultMask()

Returns the value of the default mask set on this WebSocketClient.

Returns:

true if masking is done by default, false if its not.

doPingAutoPong

public void doPingAutoPong(boolean doPings)

This sets whether or not the WebSocketClient will auto replay to websocket pings. If this is set to false the onData(WSFrame, ByteBuffer) call will get the pings and they must be handled manually.

Parameters:

doPings - set to true if the WebSocketClient should automatically reply to pings, false to handle them manually.

getPingAutoReply

public boolean getPingAutoReply()

Returns the current value set for pingAuto reply. Default value is true.

Returns:

true if the WebSocketClient will auto reply to pings, false if they are to be handled manually.

setDefaultOpCode

public void setDefaultOpCode(org.threadly.litesockets.protocols.websocket.WSOPCode wsoc)

Sets the default WSOPCode to use when calling write(ByteBuffer). Only standard WebSocket OpCodes can be used as a "default" to use anything other then the standard OpCodes use the write(ByteBuffer, WSOPCode, boolean) method.

Parameters:

wsoc - the default WSOPCode to use on this connection.

getDefaultOpCode

public org.threadly.litesockets.protocols.websocket.WSOPCode getDefaultOpCode()

Returns the current default WSOPCode in use by this connection.

Returns:

the WSOPCode currently used by default.

setRequestPath

public void setRequestPath(java.lang.String path)

This allows you to set the path used in the initial HTTP upgrade Request sent to the WebSocket server. This path can also include the query portion, and that will also be set in the request. NOTE: This must be set before connect() is called.

Parameters:

path - the path to use when doing the initial HTTP Request.

setWebSocketKey

public void setWebSocketKey(java.lang.String key)

This allows you to set the websocket key used in the initial HTTP upgrade request sent to the server. NOTE: This must be set before connect() is called.

Parameters:

key - the key to use for the upgrade request.

setWebSocketVersion

public void setWebSocketVersion(int version)

This allows you to set the websocket version used in the initial HTTP upgrade request. Be careful with this, this current implementation only parse the current standard, version 13. NOTE: This must be set before connect() is called.

Parameters:

version - the version to use.

setExtraHeader

public void setExtraHeader(java.lang.String key,
                           java.lang.String value)

This allows you to set extra headers or change any header on the HTTP upgrade request sent to the server. NOTE: This must be set before connect() is called. NOTE: You can override any header here, make sure you know what your doing!

Parameters:

key - The HTTP HeaderKey.

value - The HTTP HeaderValue.

setWebSocketDataReader

public void setWebSocketDataReader(WSClient.WebSocketDataReader reader)

Sets the WSClient.WebSocketDataReader for this client. This will be used for callbacks when full websocket frames are received. These call backs will happen in order and in a thread safe way (per client). NOTE: this can be set to null but if it is all reads for this client will be blocked till its set again.

Parameters:

reader - the WSClient.WebSocketDataReader to use for this client.

setRequestResponseHeaders

public void setRequestResponseHeaders(org.threadly.litesockets.protocols.http.request.HTTPRequest httpRequest,
                                      org.threadly.litesockets.protocols.http.response.HTTPResponse httpResponse,
                                      boolean writeRequest)

Description copied from interface: StreamingClient

Sets the HTTPRequest and HTTPResponse allowing the streaming client to start streaming w/o sending these in itself. This is used for the server side of streaming.

Specified by:

setRequestResponseHeaders in interface StreamingClient

write

public org.threadly.concurrent.future.ListenableFuture<?> write(java.nio.ByteBuffer bb)

Description copied from interface: StreamingClient

This performs a write to the connection.

Specified by:

write in interface StreamingClient

Parameters:

bb - the ByteBuffer to write to socket.

Returns:

a ListenableFuture that will be completed once the frame has been fully written to the socket.

getClientsThreadExecutor

public java.util.concurrent.Executor getClientsThreadExecutor()

Description copied from interface: StreamingClient

Gets the Executor for this client.

Specified by:

getClientsThreadExecutor in interface StreamingClient

Returns:

the Executor for this client.

write

public org.threadly.concurrent.future.ListenableFuture<?> write(java.nio.ByteBuffer bb,
                                                                org.threadly.litesockets.protocols.websocket.WSOPCode opCode,
                                                                boolean mask)

This performs a write to the websocket connection. This write will use the provided mask and OpCode values, ignoring the defaults. Every ByteBuffer written is seen as an individual websocketFrame.

Parameters:

bb - the ByteBuffer to write to frame and write to the websocket.

opCode - the opCode to use in the websocket frame.

mask - sets whether or not to mask the websocket data. true to mask, false to not.

Returns:

a ListenableFuture that will be completed once the frame has been fully written to the socket.

getLastWriteFuture

public org.threadly.concurrent.future.ListenableFuture<?> getLastWriteFuture()

Specified by:

getLastWriteFuture in interface StreamingClient

connect

public org.threadly.concurrent.future.ListenableFuture<java.lang.Boolean> connect()

Description copied from interface: StreamingClient

This is called to connect this client to the server. This will also send in the HTTP upgrade request once the TCP connection is finished.

Specified by:

connect in interface StreamingClient

Returns:

a ListenableFuture that will be completed when the upgrade is complete, if the upgrade fails the a ListenableFuture be failed.

isConnected

public boolean isConnected()

Specified by:

isConnected in interface StreamingClient

Returns:

true if the client is connected and false if not.

close

public void close()

Description copied from interface: StreamingClient

This will close the client.

Specified by:

close in interface StreamingClient

addCloseListener

public void addCloseListener(java.lang.Runnable cl)

Description copied from interface: StreamingClient

Sets a runnable to be ran once this connection is closed.

Specified by:

addCloseListener in interface StreamingClient

Parameters:

cl - the runnable to run on the connection close.