com.dkfqs.tools.websocket

Class WebSocketClientContext

java.lang.Object

com.dkfqs.tools.websocket.WebSocketClientContext

public class WebSocketClientContext
extends java.lang.Object

The context of a WebSocket client. All methods are thread-safe.

See Also:

WebSocketClient

Method Summary

Modifier and Type	Method and Description
WebSocketClient	getWebSocketClient() Get the corresponding WebSocket client.
boolean	isDebugToStdout() Get if debug information should printed to stdout.
void	printDebug(java.lang.String message) Print debug information to stdout.
long	sendBinaryFrame(byte[] payload) Send a binary frame to the server which contains an enabled fin bit.
boolean	sendFrame(Frame frame) Generic method for sending a frame to the server.
long	sendPingFrame(byte[] payload) Send a ping frame to the server which contains an enabled fin bit.
long	sendPongFrame(byte[] payload) Send a pong frame to the server which contains an enabled fin bit.
long	sendTextFrame(java.lang.String payload) Send a text frame to the server which contains an enabled fin bit.

Methods inherited from class java.lang.Object

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

Method Detail

getWebSocketClient

public WebSocketClient getWebSocketClient()

Get the corresponding WebSocket client.

Returns:

the corresponding WebSocket client

sendTextFrame

public long sendTextFrame(java.lang.String payload)
                   throws java.io.IOException

Send a text frame to the server which contains an enabled fin bit.

Parameters:

payload - the payload (=text) to send

Returns:

the time in milliseconds for sending the text frame, inclusive the time for flushing the network connection.

Throws:

java.io.IOException - if somewhat fails

sendBinaryFrame

public long sendBinaryFrame(byte[] payload)
                     throws java.io.IOException

Send a binary frame to the server which contains an enabled fin bit.

Parameters:

payload - the binary payload to send

Returns:

the time in milliseconds for sending the binary frame, inclusive the time for flushing the network connection.

Throws:

java.io.IOException - if somewhat fails

sendPingFrame

public long sendPingFrame(byte[] payload)
                   throws java.io.IOException

Send a ping frame to the server which contains an enabled fin bit.

Parameters:

payload - the payload of the ping, normally use 'new byte[0]'

Returns:

the time in milliseconds for sending the ping frame, inclusive the time for flushing the network connection.

Throws:

java.io.IOException - if somewhat fails

sendPongFrame

public long sendPongFrame(byte[] payload)
                   throws java.io.IOException

Send a pong frame to the server which contains an enabled fin bit.

Parameters:

payload - the payload of the pong, normally you should return the received payload of the ping.

Returns:

the time in milliseconds for sending the pong frame, inclusive the time for flushing the network connection.

Throws:

java.io.IOException - if somewhat fails

sendFrame

public boolean sendFrame(Frame frame)
                  throws java.io.IOException

Generic method for sending a frame to the server. Note that the opcode, the payload and the fin bit of the frame must be set before calling this method.

Parameters:

frame - the frame to send

Returns:

true if the frame was sent, or false if the connection to the server is already closed, or also false if a close frame was already sent to the server.

Throws:

java.io.IOException - if somewhat fails

See Also:

Frame.setOpcode(byte), Frame.setPayload(byte[]), Frame.setFin(boolean)

isDebugToStdout

public boolean isDebugToStdout()

Get if debug information should printed to stdout.

Returns:

true if debug information should printed to stdout

See Also:

WebSocketClient.setDebugToStdout()

printDebug

public void printDebug(java.lang.String message)

Print debug information to stdout. This method does nothing if debug to stdout is not enabled.

Parameters:

message - the debug message

See Also:

WebSocketClient.setDebugToStdout()