Enum ConnectionState.State

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CLOSING
      The WebSocket is closing
      DISCONNECTED
      The WebSocket connection is disconnected.
      HANDSHAKING
      Initial state of a connection, the upgrade request / response handshake is in progress
      OPENED
      The websocket connection is established and open.
      OPENING
      Intermediate state between HANDSHAKING and OPENED, used to indicate that a upgrade request/response handshake is successful, but the Application provided socket's onOpen code has yet completed.
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private State()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static ConnectionState.State valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ConnectionState.State[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • HANDSHAKING

        public static final ConnectionState.State HANDSHAKING
        Initial state of a connection, the upgrade request / response handshake is in progress
      • OPENING

        public static final ConnectionState.State OPENING
        Intermediate state between HANDSHAKING and OPENED, used to indicate that a upgrade request/response handshake is successful, but the Application provided socket's onOpen code has yet completed.

        This state is to allow the local socket endpoint to initiate the sending of messages and frames, but to NOT start reading yet.

      • OPENED

        public static final ConnectionState.State OPENED
        The websocket connection is established and open.

        This indicates that the Upgrade has succeed, and the Application provided socket's onOpen code has returned.

        It is now time to start reading from the remote endpoint.

      • CLOSING

        public static final ConnectionState.State CLOSING
        The WebSocket is closing

        There are several conditions that would start this state.

        - A CLOSE Frame has been received (and parsed) from the remote endpoint - A CLOSE Frame has been enqueued by the local endpoint

      • DISCONNECTED

        public static final ConnectionState.State DISCONNECTED
        The WebSocket connection is disconnected.

        Connection is complete and no longer valid.

    • Constructor Detail

      • State

        private State()
    • Method Detail

      • values

        public static ConnectionState.State[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (ConnectionState.State c : ConnectionState.State.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static ConnectionState.State valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null