Package com.iizix.comm

Interface GCloseCodes

  • All Known Implementing Classes:
    SessionTransMgr
    public interface GCloseCodes
    User close codes for WebSockets used between iizi Server and Client.
    Author:
    Christopher Mindus

    • Field Summary

      Fields 
      Modifier and TypeFieldDescription
      static intCC_APPMSG
      Close code for application message, i.e.
      static intCC_DISPOSED
      Close code indicating the session to reconnect to has been disposed of.
      static intCC_HISTORY_ERROR
      Close code indicating a problem with transaction history for reconnecting sessions.
      static intCC_OCCUPIED
      Close code used to indicate that the reconnecting session is occupied by an existing session.
      static intCC_PAUSE
      Code code indicating either party wishes to enter pause, i.e.
      static intCC_USERINFO
      Close code for user information.

    • Method Summary

      Static Methods 
      Modifier and TypeMethodDescription
      static java.lang.StringgetCloseCodeDescription​(int closeCode)
      Method to get a descriptive English text for a close code, including the standard close codes for WebSocket.

    • Field Detail

      • CC_PAUSE

        static final int CC_PAUSE
        Code code indicating either party wishes to enter pause, i.e. close communication and later reconnect to the session on hold.
        See Also:
        Constant Field Values

      • CC_DISPOSED

        static final int CC_DISPOSED
        Close code indicating the session to reconnect to has been disposed of.
        See Also:
        Constant Field Values

      • CC_OCCUPIED

        static final int CC_OCCUPIED
        Close code used to indicate that the reconnecting session is occupied by an existing session.
        See Also:
        Constant Field Values

      • CC_HISTORY_ERROR

        static final int CC_HISTORY_ERROR
        Close code indicating a problem with transaction history for reconnecting sessions.
        See Also:
        Constant Field Values

      • CC_APPMSG

        static final int CC_APPMSG
        Close code for application message, i.e. why an app cannot start.
        See Also:
        Constant Field Values

    • Method Detail

      • getCloseCodeDescription

        static java.lang.String getCloseCodeDescription​(int closeCode)
        Method to get a descriptive English text for a close code, including the standard close codes for WebSocket.
        Parameters:
        closeCode - The close code.
        Returns:
        A descriptive text of the close code.