Interface IWebSocketProcessor

  • All Known Implementing Classes:
    AbstractWebSocketProcessor

    public interface IWebSocketProcessor
    Processes web socket messages.
    Since:
    6.0
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void onClose​(int closeCode, java.lang.String message)
      A notification after the close of the web socket connection.
      void onError​(java.lang.Throwable t)
      A notification after a communication error.
      void onMessage​(byte[] data, int offset, int length)
      Called when a binary message arrives from the client
      void onMessage​(java.lang.String message)
      Called when a text message arrives from the client
      void onOpen​(java.lang.Object containerConnection)
      A client successfully has made a web socket connection.
    • Method Detail

      • onMessage

        void onMessage​(java.lang.String message)
        Called when a text message arrives from the client
        Parameters:
        message - the text message from the client
      • onMessage

        void onMessage​(byte[] data,
                       int offset,
                       int length)
        Called when a binary message arrives from the client
        Parameters:
        data - the binary message from the client
        offset - the offset to read from
        length - how much data to read
      • onOpen

        void onOpen​(java.lang.Object containerConnection)
        A client successfully has made a web socket connection.
        Parameters:
        containerConnection - the web socket connection to use to communicate with the client
      • onClose

        void onClose​(int closeCode,
                     java.lang.String message)
        A notification after the close of the web socket connection. The connection could be closed by either the client or the server
        Parameters:
        closeCode -
        message -
      • onError

        void onError​(java.lang.Throwable t)
        A notification after a communication error.
        Parameters:
        t - The throwable for the communication problem