WebSocketAdapter (com.neovisionaries:nv-websocket-client 1.16 API)

java.lang.Object
- com.neovisionaries.ws.client.WebSocketAdapter

All Implemented Interfaces:

WebSocketListener
```
public class WebSocketAdapter
extends Object
implements WebSocketListener
```
An empty implementation of WebSocketListener interface.

See Also:

WebSocketListener

Constructor Summary

Constructors
Constructor and Description

WebSocketAdapter()

Constructors
Constructor and Description
`WebSocketAdapter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`handleCallbackError(WebSocket websocket, Throwable cause)` Called when an `onXxx()` method threw a `Throwable`.
`void`	`onBinaryFrame(WebSocket websocket, WebSocketFrame frame)` Called when a binary frame (opcode = 0x2) was received.
`void`	`onBinaryMessage(WebSocket websocket, byte[] binary)` Called when a binary message was received.
`void`	`onCloseFrame(WebSocket websocket, WebSocketFrame frame)` Called when a close frame (opcode = 0x8) was received.
`void`	`onConnected(WebSocket websocket, Map<String,List<String>> headers)` Called after the opening handshake of the web socket connection succeeded.
`void`	`onConnectError(WebSocket websocket, WebSocketException exception)` Called when `WebSocket.connectAsynchronously()` failed.
`void`	`onContinuationFrame(WebSocket websocket, WebSocketFrame frame)` Called when a continuation frame (opcode = 0x0) was received.
`void`	`onDisconnected(WebSocket websocket, WebSocketFrame serverCloseFrame, WebSocketFrame clientCloseFrame, boolean closedByServer)` Called after the web socket connection was closed.
`void`	`onError(WebSocket websocket, WebSocketException cause)` Call when an error occurred.
`void`	`onFrame(WebSocket websocket, WebSocketFrame frame)` Called when a frame was received.
`void`	`onFrameError(WebSocket websocket, WebSocketException cause, WebSocketFrame frame)` Called when a frame failed to be read from the web socket.
`void`	`onFrameSent(WebSocket websocket, WebSocketFrame frame)` Called when a web socket frame was sent to the server (but not flushed yet).
`void`	`onFrameUnsent(WebSocket websocket, WebSocketFrame frame)` Called when a web socket frame was not sent to the server because a close frame has already been sent.
`void`	`onMessageDecompressionError(WebSocket websocket, WebSocketException cause, byte[] compressed)` Called when it failed to decompress a message.
`void`	`onMessageError(WebSocket websocket, WebSocketException cause, List<WebSocketFrame> frames)` Called when it failed to concatenate payloads of multiple frames to construct a message.
`void`	`onPingFrame(WebSocket websocket, WebSocketFrame frame)` Called when a ping frame (opcode = 0x9) was received.
`void`	`onPongFrame(WebSocket websocket, WebSocketFrame frame)` Called when a pong frame (opcode = 0xA) was received.
`void`	`onSendError(WebSocket websocket, WebSocketException cause, WebSocketFrame frame)` Called when an error occurred when a frame was tried to be sent to the server.
`void`	`onSendingFrame(WebSocket websocket, WebSocketFrame frame)` Called before a web socket frame is sent.
`void`	`onStateChanged(WebSocket websocket, WebSocketState newState)` Called after the state of the web socket changed.
`void`	`onTextFrame(WebSocket websocket, WebSocketFrame frame)` Called when a text frame (opcode = 0x1) was received.
`void`	`onTextMessage(WebSocket websocket, String text)` Called when a text message was received.
`void`	`onTextMessageError(WebSocket websocket, WebSocketException cause, byte[] data)` Called when it failed to convert payload data into a string.
`void`	`onUnexpectedError(WebSocket websocket, WebSocketException cause)` Called when an uncaught throwable was detected in either the reading thread (which reads frames from the server) or the writing thread (which sends frames to the server).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WebSocketAdapter
```
public WebSocketAdapter()
```
- Method Detail
  - onStateChanged
```
public void onStateChanged(WebSocket websocket,
                           WebSocketState newState)
                    throws Exception
```
    Description copied from interface: WebSocketListener
    
    Called after the state of the web socket changed.
    
    Specified by:
    
    onStateChanged in interface WebSocketListener
    
    Parameters:
    
    websocket - The web socket.
    
    newState - The new state of the web socket.
    
    Throws:
    
    Exception - An exception thrown by an implementation of this method. The exception is passed to WebSocketListener.handleCallbackError(WebSocket, Throwable).
  - onConnected
```
public void onConnected(WebSocket websocket,
                        Map<String,List<String>> headers)
                 throws Exception
```
    Description copied from interface: WebSocketListener
    
    Called after the opening handshake of the web socket connection succeeded.
    
    Specified by:
    
    onConnected in interface WebSocketListener
    
    Parameters:
    
    websocket - The web socket.
    
    headers - HTTP headers received from the server. Keys of the map are HTTP header names such as "Sec-WebSocket-Accept". Note that the comparator used by the map is String.CASE_INSENSITIVE_ORDER.
    
    Throws:
    
    Exception - An exception thrown by an implementation of this method. The exception is passed to WebSocketListener.handleCallbackError(WebSocket, Throwable).
  - onConnectError
```
public void onConnectError(WebSocket websocket,
                           WebSocketException exception)
                    throws Exception
```
    Description copied from interface: WebSocketListener
    
    Called when WebSocket.connectAsynchronously() failed.
    Note that this method is called only when connectAsynchronously() was used and the connect() executed in the background thread failed. Neither direct synchronous connect() nor connect(ExecutorService) will trigger this callback method.
    
    Specified by:
    
    onConnectError in interface WebSocketListener
    
    Parameters:
    
    websocket - The web socket.
    
    exception - The exception thrown by connect() method.
    
    Throws:
    
    Exception - An exception thrown by an implementation of this method. The exception is passed to WebSocketListener.handleCallbackError(WebSocket, Throwable).
  - onDisconnected
```
public void onDisconnected(WebSocket websocket,
                           WebSocketFrame serverCloseFrame,
                           WebSocketFrame clientCloseFrame,
                           boolean closedByServer)
                    throws Exception
```
    Description copied from interface: WebSocketListener
    
    Called after the web socket connection was closed.
    
    Specified by:
    
    onDisconnected in interface WebSocketListener
    
    Parameters:
    
    websocket - The web socket.
    
    serverCloseFrame - The close frame which the server sent to this client. This may be null.
    
    clientCloseFrame - The close frame which this client sent to the server. This may be null.
    
    closedByServer - true if the closing handshake was started by the server. false if the closing handshake was started by the client.
    
    Throws:
    
    Exception - An exception thrown by an implementation of this method. The exception is passed to WebSocketListener.handleCallbackError(WebSocket, Throwable).
  - onFrame
```
public void onFrame(WebSocket websocket,
                    WebSocketFrame frame)
             throws Exception
```
    Description copied from interface: WebSocketListener
    
    Called when a frame was received. This method is called before an onXxxFrame method is called.
    
    Specified by:
    
    onFrame in interface WebSocketListener
    
    Parameters:
    
    websocket - The web socket.
    
    frame - The frame.
    
    Throws:
    
    Exception - An exception thrown by an implementation of this method. The exception is passed to WebSocketListener.handleCallbackError(WebSocket, Throwable).
  - onContinuationFrame
```
public void onContinuationFrame(WebSocket websocket,
                                WebSocketFrame frame)
                         throws Exception
```
    Description copied from interface: WebSocketListener
    
    Called when a continuation frame (opcode = 0x0) was received.
    
    Specified by:
    
    onContinuationFrame in interface WebSocketListener
    
    Parameters:
    
    websocket - The web socket.
    
    frame - The frame.
    
    Throws:
    
    Exception - An exception thrown by an implementation of this method. The exception is passed to WebSocketListener.handleCallbackError(WebSocket, Throwable).
  - onTextFrame
```
public void onTextFrame(WebSocket websocket,
                        WebSocketFrame frame)
                 throws Exception
```
    Description copied from interface: WebSocketListener
    
    Called when a text frame (opcode = 0x1) was received.
    
    Specified by:
    
    onTextFrame in interface WebSocketListener
    
    Parameters:
    
    websocket - The web socket.
    
    frame - The frame.
    
    Throws:
    
    Exception - An exception thrown by an implementation of this method. The exception is passed to WebSocketListener.handleCallbackError(WebSocket, Throwable).
  - onBinaryFrame
```
public void onBinaryFrame(WebSocket websocket,
                          WebSocketFrame frame)
                   throws Exception
```
    Description copied from interface: WebSocketListener
    
    Called when a binary frame (opcode = 0x2) was received.
    
    Specified by:
    
    onBinaryFrame in interface WebSocketListener
    
    Parameters:
    
    websocket - The web socket.
    
    frame - The frame.
    
    Throws:
    
    Exception - An exception thrown by an implementation of this method. The exception is passed to WebSocketListener.handleCallbackError(WebSocket, Throwable).
  - onCloseFrame
```
public void onCloseFrame(WebSocket websocket,
                         WebSocketFrame frame)
                  throws Exception
```
    Description copied from interface: WebSocketListener
    
    Called when a close frame (opcode = 0x8) was received.
    
    Specified by:
    
    onCloseFrame in interface WebSocketListener
    
    Parameters:
    
    websocket - The web socket.
    
    frame - The frame.
    
    Throws:
    
    Exception - An exception thrown by an implementation of this method. The exception is passed to WebSocketListener.handleCallbackError(WebSocket, Throwable).
  - onPingFrame
```
public void onPingFrame(WebSocket websocket,
                        WebSocketFrame frame)
                 throws Exception
```
    Description copied from interface: WebSocketListener
    
    Called when a ping frame (opcode = 0x9) was received.
    
    Specified by:
    
    onPingFrame in interface WebSocketListener
    
    Parameters:
    
    websocket - The web socket.
    
    frame - The frame.
    
    Throws:
    
    Exception - An exception thrown by an implementation of this method. The exception is passed to WebSocketListener.handleCallbackError(WebSocket, Throwable).
  - onPongFrame
```
public void onPongFrame(WebSocket websocket,
                        WebSocketFrame frame)
                 throws Exception
```
    Description copied from interface: WebSocketListener
    
    Called when a pong frame (opcode = 0xA) was received.
    
    Specified by:
    
    onPongFrame in interface WebSocketListener
    
    Parameters:
    
    websocket - The web socket.
    
    frame - The frame.
    
    Throws:
    
    Exception - An exception thrown by an implementation of this method. The exception is passed to WebSocketListener.handleCallbackError(WebSocket, Throwable).
  - onTextMessage
```
public void onTextMessage(WebSocket websocket,
                          String text)
                   throws Exception
```
    Description copied from interface: WebSocketListener
    
    Called when a text message was received.
    
    Specified by:
    
    onTextMessage in interface WebSocketListener
    
    Parameters:
    
    websocket - The web socket.
    
    text - The text message.
    
    Throws:
    
    Exception - An exception thrown by an implementation of this method. The exception is passed to WebSocketListener.handleCallbackError(WebSocket, Throwable).
  - onBinaryMessage
```
public void onBinaryMessage(WebSocket websocket,
                            byte[] binary)
                     throws Exception
```
    Description copied from interface: WebSocketListener
    
    Called when a binary message was received.
    
    Specified by:
    
    onBinaryMessage in interface WebSocketListener
    
    Parameters:
    
    websocket - The web socket.
    
    binary - The binary message.
    
    Throws:
    
    Exception - An exception thrown by an implementation of this method. The exception is passed to WebSocketListener.handleCallbackError(WebSocket, Throwable).
  - onSendingFrame
```
public void onSendingFrame(WebSocket websocket,
                           WebSocketFrame frame)
                    throws Exception
```
    Description copied from interface: WebSocketListener
    
    Called before a web socket frame is sent.
    
    Specified by:
    
    onSendingFrame in interface WebSocketListener
    
    Parameters:
    
    websocket - The web socket.
    
    frame - The frame to be sent.
    
    Throws:
    
    Exception - An exception thrown by an implementation of this method. The exception is passed to WebSocketListener.handleCallbackError(WebSocket, Throwable).
  - onFrameSent
```
public void onFrameSent(WebSocket websocket,
                        WebSocketFrame frame)
                 throws Exception
```
    Description copied from interface: WebSocketListener
    
    Called when a web socket frame was sent to the server (but not flushed yet).
    
    Specified by:
    
    onFrameSent in interface WebSocketListener
    
    Parameters:
    
    websocket - The web socket.
    
    frame - The sent frame.
    
    Throws:
    
    Exception - An exception thrown by an implementation of this method. The exception is passed to WebSocketListener.handleCallbackError(WebSocket, Throwable).
  - onFrameUnsent
```
public void onFrameUnsent(WebSocket websocket,
                          WebSocketFrame frame)
                   throws Exception
```
    Description copied from interface: WebSocketListener
    
    Called when a web socket frame was not sent to the server because a close frame has already been sent.
    Note that onFrameUnsent is not called when onSendError is called.
    
    Specified by:
    
    onFrameUnsent in interface WebSocketListener
    
    Parameters:
    
    websocket - The web socket.
    
    frame - The unsent frame.
    
    Throws:
    
    Exception - An exception thrown by an implementation of this method. The exception is passed to WebSocketListener.handleCallbackError(WebSocket, Throwable).
  - onError
```
public void onError(WebSocket websocket,
                    WebSocketException cause)
             throws Exception
```
    Description copied from interface: WebSocketListener
    
    Call when an error occurred. This method is called before an onXxxError method is called.
    
    Specified by:
    
    onError in interface WebSocketListener
    
    Parameters:
    
    websocket - The web socket.
    
    cause - An exception that represents the error.
    
    Throws:
    
    Exception - An exception thrown by an implementation of this method. The exception is passed to WebSocketListener.handleCallbackError(WebSocket, Throwable).
  - onFrameError
```
public void onFrameError(WebSocket websocket,
                         WebSocketException cause,
                         WebSocketFrame frame)
                  throws Exception
```
    Description copied from interface: WebSocketListener
    
    Called when a frame failed to be read from the web socket.
    
    Specified by:
    
    onFrameError in interface WebSocketListener
    
    Parameters:
    
    websocket - The web socket.
    
    cause - An exception that represents the error. When the error occurred because of InterruptedIOException, exception.getError() returns WebSocketError.INTERRUPTED_IN_READING. For other IO errors, exception.getError() returns WebSocketError.IO_ERROR_IN_READING. Other error codes denote protocol errors, which imply that some bugs may exist in either or both of the client-side and the server-side implementations.
    
    frame - The socket frame. If this is not null, it means that verification of the frame failed.
    
    Throws:
    
    Exception - An exception thrown by an implementation of this method. The exception is passed to WebSocketListener.handleCallbackError(WebSocket, Throwable).
  - onMessageError
```
public void onMessageError(WebSocket websocket,
                           WebSocketException cause,
                           List<WebSocketFrame> frames)
                    throws Exception
```
    Description copied from interface: WebSocketListener
    
    Called when it failed to concatenate payloads of multiple frames to construct a message. The reason of the failure is probably out-of-memory.
    
    Specified by:
    
    onMessageError in interface WebSocketListener
    
    Parameters:
    
    websocket - The web socket.
    
    cause - An exception that represents the error.
    
    frames - The list of frames that form a message. The first element is either a text frame and a binary frame, and the other frames are continuation frames.
    
    Throws:
    
    Exception - An exception thrown by an implementation of this method. The exception is passed to WebSocketListener.handleCallbackError(WebSocket, Throwable).
  - onMessageDecompressionError
```
public void onMessageDecompressionError(WebSocket websocket,
                                        WebSocketException cause,
                                        byte[] compressed)
                                 throws Exception
```
    Description copied from interface: WebSocketListener
    
    Called when it failed to decompress a message.
    
    Specified by:
    
    onMessageDecompressionError in interface WebSocketListener
    
    Parameters:
    
    websocket - The web socket.
    
    cause - An exception that represents the error.
    
    compressed - The compressed message that failed to be decompressed.
    
    Throws:
    
    Exception - An exception thrown by an implementation of this method. The exception is passed to WebSocketListener.handleCallbackError(WebSocket, Throwable).
  - onTextMessageError
```
public void onTextMessageError(WebSocket websocket,
                               WebSocketException cause,
                               byte[] data)
                        throws Exception
```
    Description copied from interface: WebSocketListener
    
    Called when it failed to convert payload data into a string. The reason of the failure is probably out-of-memory.
    
    Specified by:
    
    onTextMessageError in interface WebSocketListener
    
    Parameters:
    
    websocket - The web socket.
    
    cause - An exception that represents the error.
    
    data - The payload data that failed to be converted to a string.
    
    Throws:
    
    Exception - An exception thrown by an implementation of this method. The exception is passed to WebSocketListener.handleCallbackError(WebSocket, Throwable).
  - onSendError
```
public void onSendError(WebSocket websocket,
                        WebSocketException cause,
                        WebSocketFrame frame)
                 throws Exception
```
    Description copied from interface: WebSocketListener
    
    Called when an error occurred when a frame was tried to be sent to the server.
    
    Specified by:
    
    onSendError in interface WebSocketListener
    
    Parameters:
    
    websocket - The web socket.
    
    cause - An exception that represents the error.
    
    frame - The frame which was tried to be sent. This is null when the error code of the exception is FLUSH_ERROR.
    
    Throws:
    
    Exception - An exception thrown by an implementation of this method. The exception is passed to WebSocketListener.handleCallbackError(WebSocket, Throwable).
  - onUnexpectedError
```
public void onUnexpectedError(WebSocket websocket,
                              WebSocketException cause)
                       throws Exception
```
    Description copied from interface: WebSocketListener
    
    Called when an uncaught throwable was detected in either the reading thread (which reads frames from the server) or the writing thread (which sends frames to the server).
    
    Specified by:
    
    onUnexpectedError in interface WebSocketListener
    
    Parameters:
    
    websocket - The web socket.
    
    cause - The cause of the error.
    
    Throws:
    
    Exception - An exception thrown by an implementation of this method. The exception is passed to WebSocketListener.handleCallbackError(WebSocket, Throwable).
  - handleCallbackError
```
public void handleCallbackError(WebSocket websocket,
                                Throwable cause)
                         throws Exception
```
    Description copied from interface: WebSocketListener
    
    Called when an onXxx() method threw a Throwable.
    
    Specified by:
    
    handleCallbackError in interface WebSocketListener
    
    Parameters:
    
    websocket - The web socket.
    
    cause - The Throwable an onXxx method threw.
    
    Throws:
    
    Exception - An exception thrown by an implementation of this method. The exception is just ignored.

Class WebSocketAdapter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WebSocketAdapter

Method Detail

onStateChanged

onConnected

onConnectError

onDisconnected

onFrame

onContinuationFrame

onTextFrame

onBinaryFrame

onCloseFrame

onPingFrame

onPongFrame

onTextMessage

onBinaryMessage

onSendingFrame

onFrameSent

onFrameUnsent

onError

onFrameError

onMessageError

onMessageDecompressionError

onTextMessageError

onSendError

onUnexpectedError

handleCallbackError