tech.gusavila92.websocketclient

Class WebSocketClient

java.lang.Object

tech.gusavila92.websocketclient.WebSocketClient

public abstract class WebSocketClient
extends java.lang.Object

Implements the WebSocket protocol as defined in RFC 6455

Constructor Summary

Constructors

Constructor and Description
WebSocketClient(java.net.URI uri) Initialize all the variables

Method Summary

Modifier and Type	Method and Description
void	addHeader(java.lang.String key, java.lang.String value) Adds a new header to the set of headers that will be send into the handshake This header will be added to the set of headers: Host, Upgrade, Connection, Sec-WebSocket-Key, Sec-WebSocket-Version
void	close() Closes the WebSocket connection
void	connect() Starts a new connection to the WebSocket server
void	disableAutomaticReconnection() Indicates that a connection must not be reopened automatically due to an IOException
void	enableAutomaticReconnection(long waitTimeBeforeReconnection) Indicates that a connection must be reopened automatically due to an IOException.
abstract void	onBinaryReceived(byte[] data) Called when a binary message has been received
abstract void	onCloseReceived() Called when a close code has been received
abstract void	onException(java.lang.Exception e) Called when an exception has occurred
abstract void	onOpen() Called when the WebSocket handshake has been accepted and the WebSocket is ready to send and receive data
abstract void	onPingReceived(byte[] data) Called when a ping message has been received
abstract void	onPongReceived(byte[] data) Called when a pong message has been received
abstract void	onTextReceived(java.lang.String message) Called when a text message has been received
void	send(byte[] data) Sends a binary message If the WebSocket is not connected yet, message will be send the next time the connection is opened
void	send(java.lang.String message) Sends a text message If the WebSocket is not connected yet, message will be send the next time the connection is opened
void	setConnectTimeout(int connectTimeout) Set the timeout that will be used while the WebSocket is being connected If timeout expires before connecting, an IOException will be thrown
void	setReadTimeout(int readTimeout) Sets the timeout for considering and idle connection as dead An idle connection is a connection that has not received data for a long time If timeout expires, an IOException will be thrown and you should consider opening a new WebSocket connection, or delegate this functionality to this WebSocketClient using the method setAutomaticReconnection(true)

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketClient

public WebSocketClient(java.net.URI uri)

Initialize all the variables

Parameters:

uri - URI of the WebSocket server

Method Detail

onOpen

public abstract void onOpen()

Called when the WebSocket handshake has been accepted and the WebSocket is ready to send and receive data

onTextReceived

public abstract void onTextReceived(java.lang.String message)

Called when a text message has been received

Parameters:

message - The UTF-8 encoded text received

onBinaryReceived

public abstract void onBinaryReceived(byte[] data)

Called when a binary message has been received

Parameters:

data - The binary message received

onPingReceived

public abstract void onPingReceived(byte[] data)

Called when a ping message has been received

Parameters:

data - Optional data

onPongReceived

public abstract void onPongReceived(byte[] data)

Called when a pong message has been received

Parameters:

data - Optional data

onException

public abstract void onException(java.lang.Exception e)

Called when an exception has occurred

Parameters:

e - The exception that occurred

onCloseReceived

public abstract void onCloseReceived()

Called when a close code has been received

addHeader

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

Adds a new header to the set of headers that will be send into the handshake This header will be added to the set of headers: Host, Upgrade, Connection, Sec-WebSocket-Key, Sec-WebSocket-Version

Parameters:

key - Name of the new header

value - Value of the new header

setConnectTimeout

public void setConnectTimeout(int connectTimeout)

Set the timeout that will be used while the WebSocket is being connected If timeout expires before connecting, an IOException will be thrown

Parameters:

connectTimeout - Timeout in milliseconds

setReadTimeout

public void setReadTimeout(int readTimeout)

Sets the timeout for considering and idle connection as dead An idle connection is a connection that has not received data for a long time If timeout expires, an IOException will be thrown and you should consider opening a new WebSocket connection, or delegate this functionality to this WebSocketClient using the method setAutomaticReconnection(true)

Parameters:

readTimeout - Read timeout in milliseconds before considering an idle connection as dead

enableAutomaticReconnection

public void enableAutomaticReconnection(long waitTimeBeforeReconnection)

Indicates that a connection must be reopened automatically due to an IOException. Every time a connection fails due to an IOException, onException() method is called before establishing a new connection. A connection will be reopened automatically if an IOException occurred, but other kinds of Exception will not reopen a connection

Parameters:

waitTimeBeforeReconnection - Wait time in milliseconds before trying to establish a new WebSocket connection. For performance reasons, you should set a wait time greater than zero

disableAutomaticReconnection

public void disableAutomaticReconnection()

Indicates that a connection must not be reopened automatically due to an IOException

connect

public void connect()

Starts a new connection to the WebSocket server

send

public void send(java.lang.String message)

Sends a text message If the WebSocket is not connected yet, message will be send the next time the connection is opened

Parameters:

message - Message that will be send to the WebSocket server

send

public void send(byte[] data)

Sends a binary message If the WebSocket is not connected yet, message will be send the next time the connection is opened

Parameters:

data - Binary data that will be send to the WebSocket server

close

public void close()

Closes the WebSocket connection