Enum CloseState

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<CloseState>

    public enum CloseState
    extends java.lang.Enum<CloseState>
    The set of close states for a stream or a session.
                    rcv hc
     NOT_CLOSED ---------------> REMOTELY_CLOSED
          |                             |
       gen|                             |gen
        hc|                             |hc
          |                             |
          v              rcv hc         v
     LOCALLY_CLOSING --------------> CLOSING
          |                             |
       snd|                             |gen
        hc|                             |hc
          |                             |
          v              rcv hc         v
     LOCALLY_CLOSED ----------------> CLOSED
     
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  CloseState.Event  
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CLOSED
      Fully closed.
      CLOSING
      A half-close frame has been received and a half-close frame has been generated, but not yet sent.
      LOCALLY_CLOSED
      A half-close frame has been generated and sent.
      LOCALLY_CLOSING
      A half-close frame has been generated.
      NOT_CLOSED
      Fully open.
      REMOTELY_CLOSED
      A half-close frame has been received.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static CloseState valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static CloseState[] 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

      • NOT_CLOSED

        public static final CloseState NOT_CLOSED
        Fully open.
      • LOCALLY_CLOSING

        public static final CloseState LOCALLY_CLOSING
        A half-close frame has been generated.
      • LOCALLY_CLOSED

        public static final CloseState LOCALLY_CLOSED
        A half-close frame has been generated and sent.
      • REMOTELY_CLOSED

        public static final CloseState REMOTELY_CLOSED
        A half-close frame has been received.
      • CLOSING

        public static final CloseState CLOSING
        A half-close frame has been received and a half-close frame has been generated, but not yet sent.
      • CLOSED

        public static final CloseState CLOSED
        Fully closed.
    • Method Detail

      • values

        public static CloseState[] 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 (CloseState c : CloseState.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static CloseState 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