java.lang.Runnable, WebSocket, WebSocketListenerpublic abstract class WebSocketClient extends AbstractWebSocket implements java.lang.Runnable, WebSocket
connect(), then receive events like onMessage(String) via the overloaded methods and to send(String) data to the server.WebSocket.READYSTATE, WebSocket.Role| Modifier and Type | Field | Description |
|---|---|---|
protected java.net.URI |
uri |
The URI this channel is supposed to connect to.
|
DEFAULT_PORT, DEFAULT_WSS_PORT| Constructor | Description |
|---|---|
WebSocketClient(java.net.URI serverUri) |
Constructs a WebSocketClient instance and sets it to the connect to the
specified URI.
|
WebSocketClient(java.net.URI serverUri,
java.util.Map<java.lang.String,java.lang.String> httpHeaders) |
Constructs a WebSocketClient instance and sets it to the connect to the
specified URI.
|
WebSocketClient(java.net.URI serverUri,
Draft protocolDraft) |
Constructs a WebSocketClient instance and sets it to the connect to the
specified URI.
|
WebSocketClient(java.net.URI serverUri,
Draft protocolDraft,
java.util.Map<java.lang.String,java.lang.String> httpHeaders) |
Constructs a WebSocketClient instance and sets it to the connect to the
specified URI.
|
WebSocketClient(java.net.URI serverUri,
Draft protocolDraft,
java.util.Map<java.lang.String,java.lang.String> httpHeaders,
int connectTimeout) |
Constructs a WebSocketClient instance and sets it to the connect to the
specified URI.
|
| Modifier and Type | Method | Description |
|---|---|---|
void |
close() |
Initiates the websocket close handshake.
|
void |
close(int code) |
sends the closing handshake.
|
void |
close(int code,
java.lang.String message) |
sends the closing handshake.
|
void |
closeBlocking() |
Same as
close but blocks until the websocket closed or failed to do so. |
void |
closeConnection(int code,
java.lang.String message) |
This will close the connection immediately without a proper close handshake.
|
void |
connect() |
Initiates the websocket connection.
|
boolean |
connectBlocking() |
Same as
connect but blocks until the websocket connected or failed to do so. |
boolean |
connectBlocking(long timeout,
java.util.concurrent.TimeUnit timeUnit) |
Same as
connect but blocks with a timeout until the websocket connected or failed to do so. |
<T> T |
getAttachment() |
Getter for the connection attachment.
|
WebSocket |
getConnection() |
Getter for the engine
|
protected java.util.Collection<WebSocket> |
getConnections() |
Getter to get all the currently available connections
|
Draft |
getDraft() |
Returns the protocol version this channel uses.
For more infos see https://github.com/TooTallNate/Java-WebSocket/wiki/Drafts |
java.net.InetSocketAddress |
getLocalSocketAddress() |
Returns the address of the endpoint this socket is bound to.
|
java.net.InetSocketAddress |
getLocalSocketAddress(WebSocket conn) |
|
WebSocket.READYSTATE |
getReadyState() |
This represents the state of the connection.
|
java.net.InetSocketAddress |
getRemoteSocketAddress() |
Returns the address of the endpoint this socket is connected to, or
null if it is unconnected. |
java.net.InetSocketAddress |
getRemoteSocketAddress(WebSocket conn) |
|
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. |
java.net.Socket |
getSocket() |
Returns the socket to allow Hostname Verification
|
java.net.URI |
getURI() |
Returns the URI that this WebSocketClient is connected to.
|
boolean |
hasBufferedData() |
Checks if the websocket has buffered data
|
boolean |
isClosed() |
Is the websocket in the state CLOSED
|
boolean |
isClosing() |
Is the websocket in the state CLOSING
|
boolean |
isConnecting() |
Deprecated.
|
boolean |
isFlushAndClose() |
Returns true when no further frames may be submitted
This happens before the socket connection is closed. |
boolean |
isOpen() |
Is the websocket in the state OPEN
|
abstract void |
onClose(int code,
java.lang.String reason,
boolean remote) |
Called after the websocket connection has been closed.
|
void |
onCloseInitiated(int code,
java.lang.String reason) |
Send when this peer sends a close handshake
|
void |
onClosing(int code,
java.lang.String reason,
boolean remote) |
Called as soon as no further frames are accepted
|
abstract void |
onError(java.lang.Exception ex) |
Called when errors occurs.
|
void |
onFragment(Framedata frame) |
Deprecated.
|
abstract void |
onMessage(java.lang.String message) |
Callback for string messages received from the remote host
|
void |
onMessage(java.nio.ByteBuffer bytes) |
Callback for binary messages received from the remote host
|
abstract void |
onOpen(ServerHandshake handshakedata) |
Called after an opening handshake has been performed and the given websocket is ready to be written on.
|
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.lang.String message) |
Calls subclass' implementation of onMessage.
|
void |
onWebsocketMessage(WebSocket conn,
java.nio.ByteBuffer blob) |
Called when an entire binary frame has been received.
|
void |
onWebsocketMessageFragment(WebSocket conn,
Framedata frame) |
This default implementation does not do anything.
|
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 |
reconnect() |
Reinitiates the websocket connection.
|
boolean |
reconnectBlocking() |
Same as
reconnect but blocks until the websocket reconnected or failed to do so. |
void |
run() |
|
void |
send(byte[] data) |
Sends binary data to the connected webSocket server.
|
void |
send(java.lang.String text) |
Sends text to the connected websocket server.
|
void |
send(java.nio.ByteBuffer bytes) |
Send Binary data (plain bytes) to the other end.
|
void |
sendFragmentedFrame(Framedata.Opcode op,
java.nio.ByteBuffer buffer,
boolean fin) |
Allows to send continuous/fragmented frames conveniently.
|
void |
sendFrame(java.util.Collection<Framedata> frames) |
Send a collection of frames to the other end
|
void |
sendFrame(Framedata framedata) |
Send a frame to the other end
|
void |
sendPing() |
Send a ping to the other end
|
<T> void |
setAttachment(T attachment) |
Setter for an attachment on the socket connection.
|
void |
setProxy(java.net.Proxy proxy) |
Method to set a proxy for this connection
|
void |
setSocket(java.net.Socket socket) |
Accepts bound and unbound sockets.
This method must be called before connect. |
getConnectionLostTimeout, isReuseAddr, isTcpNoDelay, setConnectionLostTimeout, setReuseAddr, setTcpNoDelay, startConnectionLostTimer, stopConnectionLostTimerclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitonWebsocketHandshakeReceivedAsClient, onWebsocketHandshakeReceivedAsServer, onWebsocketHandshakeSentAsClient, onWebsocketPing, onWebsocketPongpublic WebSocketClient(java.net.URI serverUri)
serverUri - the server URI to connect topublic WebSocketClient(java.net.URI serverUri,
Draft protocolDraft)
serverUri - the server URI to connect toprotocolDraft - The draft which should be used for this connectionpublic WebSocketClient(java.net.URI serverUri,
java.util.Map<java.lang.String,java.lang.String> httpHeaders)
serverUri - the server URI to connect tohttpHeaders - Additional HTTP-Headerspublic WebSocketClient(java.net.URI serverUri,
Draft protocolDraft,
java.util.Map<java.lang.String,java.lang.String> httpHeaders)
serverUri - the server URI to connect toprotocolDraft - The draft which should be used for this connectionhttpHeaders - Additional HTTP-Headerspublic WebSocketClient(java.net.URI serverUri,
Draft protocolDraft,
java.util.Map<java.lang.String,java.lang.String> httpHeaders,
int connectTimeout)
serverUri - the server URI to connect toprotocolDraft - The draft which should be used for this connectionhttpHeaders - Additional HTTP-HeadersconnectTimeout - The Timeout for the connectionpublic java.net.URI getURI()
public Draft getDraft()
public java.net.Socket getSocket()
public void reconnect()
public boolean reconnectBlocking()
throws java.lang.InterruptedException
reconnect but blocks until the websocket reconnected or failed to do so.java.lang.InterruptedException - Thrown when the threads get interruptedpublic void connect()
public boolean connectBlocking()
throws java.lang.InterruptedException
connect but blocks until the websocket connected or failed to do so.java.lang.InterruptedException - Thrown when the threads get interruptedpublic boolean connectBlocking(long timeout,
java.util.concurrent.TimeUnit timeUnit)
throws java.lang.InterruptedException
connect but blocks with a timeout until the websocket connected or failed to do so.timeout - The connect timeouttimeUnit - The timeout time unitjava.lang.InterruptedException - Thrown when the threads get interruptedpublic void close()
closeBlockingpublic void closeBlocking()
throws java.lang.InterruptedException
close but blocks until the websocket closed or failed to do so.java.lang.InterruptedException - Thrown when the threads get interruptedpublic void send(java.lang.String text)
throws java.nio.channels.NotYetConnectedException
public void send(byte[] data)
throws java.nio.channels.NotYetConnectedException
public <T> T getAttachment()
WebSocketgetAttachment in interface WebSocketT - The type of the attachmentpublic <T> void setAttachment(T attachment)
WebSocketsetAttachment in interface WebSocketT - The type of the attachmentattachment - The object to be attached to the userprotected java.util.Collection<WebSocket> getConnections()
AbstractWebSocketgetConnections in class AbstractWebSocketpublic void sendPing()
throws java.nio.channels.NotYetConnectedException
WebSocketpublic void run()
run in interface java.lang.Runnablepublic WebSocket.READYSTATE getReadyState()
getReadyState in interface WebSocketpublic final void onWebsocketMessage(WebSocket conn, java.lang.String message)
onWebsocketMessage in interface WebSocketListenerconn - The WebSocket instance this event is occurring on.message - The UTF-8 decoded message that was received.public final void onWebsocketMessage(WebSocket conn, java.nio.ByteBuffer blob)
WebSocketListeneronWebsocketMessage in interface WebSocketListenerconn - The WebSocket instance this event is occurring on.blob - The binary message that was received.public void onWebsocketMessageFragment(WebSocket conn, Framedata frame)
WebSocketAdapteronWebsocketMessageFragment in interface WebSocketListeneronWebsocketMessageFragment in class WebSocketAdapterconn - The WebSocket instance this event is occurring on.frame - The fragmented frameWebSocketListener.onWebsocketMessageFragment(WebSocket, Framedata)public final void onWebsocketOpen(WebSocket conn, Handshakedata handshake)
onWebsocketOpen in interface WebSocketListenerconn - The WebSocket instance this event is occuring on.handshake - The handshake of the websocket instancepublic final void onWebsocketClose(WebSocket conn, int code, java.lang.String reason, boolean remote)
onWebsocketClose in interface WebSocketListenerconn - The WebSocket instance this event is occuring on.code - The codes can be looked up here: CloseFramereason - Additional information stringremote - Returns whether or not the closing of the connection was initiated by the remote host.public final void onWebsocketError(WebSocket conn, java.lang.Exception ex)
onWebsocketError in interface WebSocketListenerconn - The WebSocket instance this event is occuring on.ex - The exception that occurred. public final void onWriteDemand(WebSocket conn)
WebSocketListeneronWriteDemand in interface WebSocketListenerconn - The WebSocket instance this event is occuring on.public void onWebsocketCloseInitiated(WebSocket conn, int code, java.lang.String reason)
WebSocketListeneronWebsocketCloseInitiated in interface WebSocketListenerconn - The WebSocket instance this event is occuring on.code - The codes can be looked up here: CloseFramereason - Additional information stringpublic void onWebsocketClosing(WebSocket conn, int code, java.lang.String reason, boolean remote)
WebSocketListeneronWebsocketClosing in interface WebSocketListenerconn - The WebSocket instance this event is occuring on.code - The codes can be looked up here: CloseFramereason - Additional information stringremote - Returns whether or not the closing of the connection was initiated by the remote host.public void onCloseInitiated(int code,
java.lang.String reason)
code - The codes can be looked up here: CloseFramereason - Additional information stringpublic void onClosing(int code,
java.lang.String reason,
boolean remote)
code - The codes can be looked up here: CloseFramereason - Additional information stringremote - Returns whether or not the closing of the connection was initiated by the remote host.public WebSocket getConnection()
public java.net.InetSocketAddress getLocalSocketAddress(WebSocket conn)
getLocalSocketAddress in interface WebSocketListenerconn - The WebSocket instance this event is occuring on.WebSocket.getLocalSocketAddress()public java.net.InetSocketAddress getRemoteSocketAddress(WebSocket conn)
getRemoteSocketAddress in interface WebSocketListenerconn - The WebSocket instance this event is occuring on.null if it is unconnected.WebSocket.getRemoteSocketAddress()public abstract void onOpen(ServerHandshake handshakedata)
handshakedata - The handshake of the websocket instancepublic abstract void onMessage(java.lang.String message)
message - The UTF-8 decoded message that was received.onMessage(ByteBuffer)public abstract void onClose(int code,
java.lang.String reason,
boolean remote)
code - The codes can be looked up here: CloseFramereason - Additional information stringremote - Returns whether or not the closing of the connection was initiated by the remote host.public abstract void onError(java.lang.Exception ex)
onClose(int, String, boolean) will be called additionally.ex - The exception causing this errorpublic void onMessage(java.nio.ByteBuffer bytes)
bytes - The binary message that was received.onMessage(String)@Deprecated public void onFragment(Framedata frame)
frame - The fragmented frameWebSocket.sendFragmentedFrame(org.java_websocket.framing.Framedata.Opcode, ByteBuffer, boolean)public void setProxy(java.net.Proxy proxy)
proxy - the proxy to use for this websocket clientpublic void setSocket(java.net.Socket socket)
connect.
If the given socket is not yet bound it will be bound to the uri specified in the constructor.socket - The socket which should be used for the connectionpublic void sendFragmentedFrame(Framedata.Opcode op, java.nio.ByteBuffer buffer, boolean fin)
WebSocketsendFragmentedFrame in interface WebSocketop - 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.public boolean isOpen()
WebSocketpublic boolean isFlushAndClose()
WebSocketisFlushAndClose in interface WebSocketpublic boolean isClosed()
WebSocketpublic boolean isClosing()
WebSocket@Deprecated public boolean isConnecting()
WebSocketisConnecting in interface WebSocketpublic boolean hasBufferedData()
WebSockethasBufferedData in interface WebSocketpublic void close(int code)
WebSocketpublic void close(int code,
java.lang.String message)
WebSocketpublic void closeConnection(int code,
java.lang.String message)
WebSocketcloseConnection in interface WebSocketcode - the closing codemessage - the closing messagepublic void send(java.nio.ByteBuffer bytes)
throws java.lang.IllegalArgumentException,
java.nio.channels.NotYetConnectedException
WebSocketpublic void sendFrame(Framedata framedata)
WebSocketpublic void sendFrame(java.util.Collection<Framedata> frames)
WebSocketpublic java.net.InetSocketAddress getLocalSocketAddress()
WebSocketgetLocalSocketAddress in interface WebSocketpublic java.net.InetSocketAddress getRemoteSocketAddress()
WebSocketnull if it is unconnected.getRemoteSocketAddress in interface WebSocketpublic java.lang.String getResourceDescriptor()
WebSocketgetResourceDescriptor in interface WebSocket