org.java_websocket.client

Class WebSocketClient

java.lang.Object

org.java_websocket.WebSocketAdapter

org.java_websocket.client.WebSocketClient

All Implemented Interfaces:

java.lang.Runnable, WebSocketListener

public abstract class WebSocketClient
extends WebSocketAdapter
implements java.lang.Runnable

The WebSocketClient is an abstract class that expects a valid "ws://" URI to connect to. When connected, an instance recieves important events related to the life of the connection. A subclass must implement onOpen, onClose, and onMessage to be useful. An instance can send messages to it's connected server via the send method.

Author:

Nathan Rajlich

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	WebSocketClient.DefaultClientProxyChannel
static interface	WebSocketClient.WebSocketClientFactory

Field Summary

Fields

Modifier and Type	Field and Description
protected java.net.URI	uri The URI this channel is supposed to connect to.

Constructor Summary

Constructors

Constructor and Description
WebSocketClient(java.net.URI serverURI)
WebSocketClient(java.net.URI serverUri, Draft draft) Constructs a WebSocketClient instance and sets it to the connect to the specified URI.
WebSocketClient(java.net.URI serverUri, Draft draft, java.util.Map<java.lang.String,java.lang.String> headers, int connecttimeout)

Method Summary

Modifier and Type	Method and Description
void	close()
void	closeBlocking()
void	connect() Starts a background thread that attempts and maintains a WebSocket connection to the URI specified in the constructor or via setURI.
boolean	connectBlocking() Same as connect but blocks until the websocket connected or failed to do so. Returns whether it succeeded or not.
java.nio.channels.ByteChannel	createProxyChannel(java.nio.channels.ByteChannel towrap)
WebSocket	getConnection()
Draft	getDraft() Returns the protocol version this channel uses.
java.net.InetSocketAddress	getLocalSocketAddress(WebSocket conn)
WebSocket.READYSTATE	getReadyState() This represents the state of the connection.
java.net.InetSocketAddress	getRemoteSocketAddress(WebSocket conn)
java.net.URI	getURI() Gets the URI that this WebSocketClient is connected to.
WebSocketFactory	getWebSocketFactory()
abstract void	onClose(int code, java.lang.String reason, boolean remote)
void	onCloseInitiated(int code, java.lang.String reason)
void	onClosing(int code, java.lang.String reason, boolean remote)
abstract void	onError(java.lang.Exception ex)
void	onMessage(java.nio.ByteBuffer bytes)
abstract void	onMessage(java.lang.String message)
abstract void	onOpen(ServerHandshake handshakedata)
void	onWebsocketClose(WebSocket conn, int code, java.lang.String reason, boolean remote) Calls subclass' implementation of onClose.
void	onWebsocketCloseInitiated(WebSocket conn, int code, java.lang.String reason) send when this peer sends a close handshake
void	onWebsocketClosing(WebSocket conn, int code, java.lang.String reason, boolean remote) called as soon as no further frames are accepted
void	onWebsocketError(WebSocket conn, java.lang.Exception ex) Calls subclass' implementation of onIOError.
void	onWebsocketMessage(WebSocket conn, java.nio.ByteBuffer blob) Called when an entire binary frame has been received.
void	onWebsocketMessage(WebSocket conn, java.lang.String message) Calls subclass' implementation of onMessage.
void	onWebsocketOpen(WebSocket conn, Handshakedata handshake) Calls subclass' implementation of onOpen.
void	onWriteDemand(WebSocket conn) This method is used to inform the selector thread that there is data queued to be written to the socket.
void	run()
void	send(byte[] data) Sends data to the connected WebSocket server.
void	send(java.lang.String text) Sends text to the connected WebSocket server.
void	setProxy(java.net.InetSocketAddress proxyaddress)
void	setWebSocketFactory(WebSocketClient.WebSocketClientFactory wsf)

Methods inherited from class org.java_websocket.WebSocketAdapter

getFlashPolicy, onWebsocketHandshakeReceivedAsClient, onWebsocketHandshakeReceivedAsServer, onWebsocketHandshakeSentAsClient, onWebsocketMessageFragment, onWebsocketPing, onWebsocketPong

Methods inherited from class java.lang.Object

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

Field Detail

uri

protected java.net.URI uri

The URI this channel is supposed to connect to.

Constructor Detail

WebSocketClient

public WebSocketClient(java.net.URI serverURI)

WebSocketClient

public WebSocketClient(java.net.URI serverUri,
                       Draft draft)

Constructs a WebSocketClient instance and sets it to the connect to the specified URI. The channel does not attampt to connect automatically. You must call connect first to initiate the socket connection.

WebSocketClient

public WebSocketClient(java.net.URI serverUri,
                       Draft draft,
                       java.util.Map<java.lang.String,java.lang.String> headers,
                       int connecttimeout)

Method Detail

getURI

public java.net.URI getURI()

Gets the URI that this WebSocketClient is connected to.

Returns:

The URI for this WebSocketClient.

getDraft

public Draft getDraft()

Returns the protocol version this channel uses.

connect

public void connect()

Starts a background thread that attempts and maintains a WebSocket connection to the URI specified in the constructor or via setURI. setURI.

connectBlocking

public boolean connectBlocking()
                        throws java.lang.InterruptedException

Same as connect but blocks until the websocket connected or failed to do so.
Returns whether it succeeded or not.

Throws:

java.lang.InterruptedException

close

public void close()

closeBlocking

public void closeBlocking()
                   throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

send

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

Sends text to the connected WebSocket server.

Parameters:

text - The String to send to the WebSocket server.

Throws:

java.nio.channels.NotYetConnectedException

send

public void send(byte[] data)
          throws java.nio.channels.NotYetConnectedException

Sends data to the connected WebSocket server.

Parameters:

data - The Byte-Array of data to send to the WebSocket server.

Throws:

java.nio.channels.NotYetConnectedException

run

public void run()

Specified by:

run in interface java.lang.Runnable

getReadyState

public WebSocket.READYSTATE getReadyState()

This represents the state of the connection. You can use this method instead of

onWebsocketMessage

public final void onWebsocketMessage(WebSocket conn,
                                     java.lang.String message)

Calls subclass' implementation of onMessage.

Specified by:

onWebsocketMessage in interface WebSocketListener

Parameters:

conn -

message -

onWebsocketMessage

public final void onWebsocketMessage(WebSocket conn,
                                     java.nio.ByteBuffer blob)

Description copied from interface: WebSocketListener

Called when an entire binary frame has been received. Do whatever you want here...

Specified by:

onWebsocketMessage in interface WebSocketListener

Parameters:

conn - The WebSocket instance this event is occurring on.

blob - The binary message that was received.

onWebsocketOpen

public final void onWebsocketOpen(WebSocket conn,
                                  Handshakedata handshake)

Calls subclass' implementation of onOpen.

Specified by:

onWebsocketOpen in interface WebSocketListener

Parameters:

conn -

onWebsocketClose

public final void onWebsocketClose(WebSocket conn,
                                   int code,
                                   java.lang.String reason,
                                   boolean remote)

Calls subclass' implementation of onClose.

Specified by:

onWebsocketClose in interface WebSocketListener

Parameters:

conn -

onWebsocketError

public final void onWebsocketError(WebSocket conn,
                                   java.lang.Exception ex)

Calls subclass' implementation of onIOError.

Specified by:

onWebsocketError in interface WebSocketListener

Parameters:

conn -

ex - The exception that occurred.
Might be null if the exception is not related to any specific connection. For example if the server port could not be bound.

onWriteDemand

public final void onWriteDemand(WebSocket conn)

Description copied from interface: WebSocketListener

This method is used to inform the selector thread that there is data queued to be written to the socket.

Specified by:

onWriteDemand in interface WebSocketListener

onWebsocketCloseInitiated

public void onWebsocketCloseInitiated(WebSocket conn,
                                      int code,
                                      java.lang.String reason)

Description copied from interface: WebSocketListener

send when this peer sends a close handshake

Specified by:

onWebsocketCloseInitiated in interface WebSocketListener

onWebsocketClosing

public void onWebsocketClosing(WebSocket conn,
                               int code,
                               java.lang.String reason,
                               boolean remote)

Description copied from interface: WebSocketListener

called as soon as no further frames are accepted

Specified by:

onWebsocketClosing in interface WebSocketListener

onCloseInitiated

public void onCloseInitiated(int code,
                             java.lang.String reason)

onClosing

public void onClosing(int code,
                      java.lang.String reason,
                      boolean remote)

getConnection

public WebSocket getConnection()

setWebSocketFactory

public final void setWebSocketFactory(WebSocketClient.WebSocketClientFactory wsf)

getWebSocketFactory

public final WebSocketFactory getWebSocketFactory()

getLocalSocketAddress

public java.net.InetSocketAddress getLocalSocketAddress(WebSocket conn)

Specified by:

getLocalSocketAddress in interface WebSocketListener

getRemoteSocketAddress

public java.net.InetSocketAddress getRemoteSocketAddress(WebSocket conn)

Specified by:

getRemoteSocketAddress in interface WebSocketListener

onOpen

public abstract void onOpen(ServerHandshake handshakedata)

onMessage

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

onClose

public abstract void onClose(int code,
                             java.lang.String reason,
                             boolean remote)

onError

public abstract void onError(java.lang.Exception ex)

onMessage

public void onMessage(java.nio.ByteBuffer bytes)

createProxyChannel

public java.nio.channels.ByteChannel createProxyChannel(java.nio.channels.ByteChannel towrap)

setProxy

public void setProxy(java.net.InetSocketAddress proxyaddress)