com.dkfqs.tools.websocket

Interface WebSocketClientListenerInterface

public interface WebSocketClientListenerInterface

The WebSocket client listener interface.

See Also:

WebSocketClient

Method Summary

Modifier and Type	Method and Description
default void	onBinary(WebSocketClientContext clientContext, byte[] data, long receiveTimeMillis) Optional: Called when the last frame of a stream of binary-frames is received.
void	onClose(WebSocketClientContext clientContext) Called when the WebSocket connection is closed by the server.
default void	onError(WebSocketClientContext clientContext, java.lang.Throwable error, Frame frame) Optional: Called when an communication error or an internal error has occurred.
default void	onFrame(WebSocketClientContext clientContext, Frame frame, long receiveTimeMillis) Optional: Called for every single received frame - regardless if the fin bit is set or not.
default void	onOpen(WebSocketClientContext clientContext) Optional: Called when WebSocket connection is established to the server.
default void	onPing(WebSocketClientContext clientContext, byte[] data, long receiveTimeMillis) Optional: Called when a ping is received from the server.
default void	onPong(WebSocketClientContext clientContext, byte[] data, long receiveTimeMillis) Optional: Called when a pong is received from the server.
void	onText(WebSocketClientContext clientContext, java.lang.String text, long receiveTimeMillis) Called when the last frame of a stream of text-frames is received.

Method Detail

onOpen

default void onOpen(WebSocketClientContext clientContext)
             throws java.io.IOException,
                    java.lang.InterruptedException,
                    WebSocketClientListenerException

Optional: Called when WebSocket connection is established to the server.

Parameters:

clientContext - The context of the WebSocket client

Throws:

java.io.IOException - if an I/O error did occur

java.lang.InterruptedException - if the current thread was interrupted

WebSocketClientListenerException - if somewhat went wrong in the implementation of this method

onFrame

default void onFrame(WebSocketClientContext clientContext,
                     Frame frame,
                     long receiveTimeMillis)
              throws java.io.IOException,
                     java.lang.InterruptedException,
                     WebSocketClientListenerException

Optional: Called for every single received frame - regardless if the fin bit is set or not.

Parameters:

clientContext - The context of the WebSocket client

frame - the received frame

receiveTimeMillis - the time in milliseconds elapsed from receiving the first byte of the frame until the last byte of the frame

Throws:

java.io.IOException - if an I/O error did occur

java.lang.InterruptedException - if the current thread was interrupted

WebSocketClientListenerException - if somewhat went wrong in the implementation of this method

onText

void onText(WebSocketClientContext clientContext,
            java.lang.String text,
            long receiveTimeMillis)
     throws java.io.IOException,
            java.lang.InterruptedException,
            WebSocketClientListenerException

Called when the last frame of a stream of text-frames is received.

Parameters:

clientContext - The context of the WebSocket client

text - the received text, combined overall received text-frame fragments.

receiveTimeMillis - the time in milliseconds elapsed from receiving the first byte of the first frame until receiving the last byte of the last frame

Throws:

java.io.IOException - if an I/O error did occur

java.lang.InterruptedException - if the current thread was interrupted

WebSocketClientListenerException - if somewhat went wrong in the implementation of this method

onBinary

default void onBinary(WebSocketClientContext clientContext,
                      byte[] data,
                      long receiveTimeMillis)
               throws java.io.IOException,
                      java.lang.InterruptedException,
                      WebSocketClientListenerException

Optional: Called when the last frame of a stream of binary-frames is received.

Parameters:

clientContext - The context of the WebSocket client

data - the received data, combined overall received binary-frame fragments

receiveTimeMillis - the time in milliseconds elapsed from receiving the first byte of the first frame until receiving the last byte of the last frame

Throws:

java.io.IOException - if an I/O error did occur

java.lang.InterruptedException - if the current thread was interrupted

WebSocketClientListenerException - if somewhat went wrong in the implementation of this method

onPing

default void onPing(WebSocketClientContext clientContext,
                    byte[] data,
                    long receiveTimeMillis)
             throws java.io.IOException,
                    java.lang.InterruptedException,
                    WebSocketClientListenerException

Optional: Called when a ping is received from the server. By default, a pong is send to the server.

Parameters:

clientContext - The context of the WebSocket client

data - the payload of the ping

receiveTimeMillis - the time in milliseconds for receiving the ping

Throws:

java.io.IOException - if an I/O error did occur

java.lang.InterruptedException - if the current thread was interrupted

WebSocketClientListenerException - if somewhat went wrong in the implementation of this method

onPong

default void onPong(WebSocketClientContext clientContext,
                    byte[] data,
                    long receiveTimeMillis)
             throws java.io.IOException,
                    java.lang.InterruptedException,
                    WebSocketClientListenerException

Optional: Called when a pong is received from the server.

Parameters:

clientContext - The context of the WebSocket client

data - the payload of the pong

receiveTimeMillis - the time in milliseconds for receiving the pong

Throws:

java.io.IOException - if an I/O error did occur

java.lang.InterruptedException - if the current thread was interrupted

WebSocketClientListenerException - if somewhat went wrong in the implementation of this method

onClose

void onClose(WebSocketClientContext clientContext)
      throws java.io.IOException,
             java.lang.InterruptedException,
             WebSocketClientListenerException

Called when the WebSocket connection is closed by the server. Note that this method is *NOT* called when the WebSocket connection is closed by the client.

Parameters:

clientContext - The context of the WebSocket client

Throws:

java.io.IOException - if an I/O error did occur

java.lang.InterruptedException - if the current thread was interrupted

WebSocketClientListenerException - if somewhat went wrong in the implementation of this method

onError

default void onError(WebSocketClientContext clientContext,
                     java.lang.Throwable error,
                     Frame frame)
              throws java.io.IOException,
                     java.lang.InterruptedException,
                     WebSocketClientListenerException

Optional: Called when an communication error or an internal error has occurred. By default, a stack trace is printed to stdout.

Parameters:

clientContext - The context of the WebSocket client

error - the occurred error

frame - the frame for which the error occurred, or null if no such information is available

Throws:

java.io.IOException - if an I/O error did occur

java.lang.InterruptedException - if the current thread was interrupted

WebSocketClientListenerException - if somewhat went wrong in the implementation of this method