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 Link icon

    Fields
    Modifier and Type
    Field
    Description
    static final int
    Close code for application message, i.e.
    static final int
    Close code indicating the session to reconnect to has been disposed of.
    static final int
    Close code indicating a problem with transaction history for reconnecting sessions.
    static final int
    Close code used to indicate that the reconnecting session is occupied by an existing session.
    static final int
    Code code indicating either party wishes to enter pause, i.e.
    static final int
    Close code for user information.
  • Method Summary Link icon

    Static Methods
    Modifier and Type
    Method
    Description
    static String
    getCloseCodeDescription(int closeCode)
    Method to get a descriptive English text for a close code, including the standard close codes for WebSocket.
  • Field Details Link icon

    • CC_PAUSE Link icon

      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:
    • CC_DISPOSED Link icon

      static final int CC_DISPOSED
      Close code indicating the session to reconnect to has been disposed of.
      See Also:
    • CC_OCCUPIED Link icon

      static final int CC_OCCUPIED
      Close code used to indicate that the reconnecting session is occupied by an existing session.
      See Also:
    • CC_HISTORY_ERROR Link icon

      static final int CC_HISTORY_ERROR
      Close code indicating a problem with transaction history for reconnecting sessions.
      See Also:
    • CC_APPMSG Link icon

      static final int CC_APPMSG
      Close code for application message, i.e. why an app cannot start.
      See Also:
    • CC_USERINFO Link icon

      static final int CC_USERINFO
      Close code for user information.
      See Also:
  • Method Details Link icon

    • getCloseCodeDescription Link icon

      static 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.