Interface WebSocketConnectionListener

    • Method Detail

      • onWebSocketClose

        void onWebSocketClose​(int statusCode,
                              java.lang.String reason)
        A Close Event was received.

        The underlying Connection will be considered closed at this point.

        statusCode - the close status code. (See StatusCode)
        reason - the optional reason for the close.
      • onWebSocketConnect

        void onWebSocketConnect​(Session session)
        A WebSocket Session has connected successfully and is ready to be used.

        Note: It is a good idea to track this session as a field in your object so that you can write messages back via the RemoteEndpoint

        session - the websocket session.
      • onWebSocketError

        void onWebSocketError​(java.lang.Throwable cause)
        A WebSocket exception has occurred.

        This is a way for the internal implementation to notify of exceptions occurred during the processing of websocket.

        Usually this occurs from bad / malformed incoming packets. (example: bad UTF8 data, frames that are too big, violations of the spec)

        This will result in the Session being closed by the implementing side.

        cause - the error that occurred.