Enum CloseHandler.CloseEvent

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<CloseHandler.CloseEvent>
    Enclosing class:
    CloseHandler

    public static enum CloseHandler.CloseEvent
    extends java.lang.Enum<CloseHandler.CloseEvent>
    These events indicate an event was observed from the protocol or Channel that indicates the end of the Channel and no further requests should be attempted.
    • Method Summary

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

      • PROTOCOL_CLOSING_OUTBOUND

        public static final CloseHandler.CloseEvent PROTOCOL_CLOSING_OUTBOUND
        Outbound protocol close command observed eg. HTTP header: Connection: close.
      • PROTOCOL_CLOSING_INBOUND

        public static final CloseHandler.CloseEvent PROTOCOL_CLOSING_INBOUND
        Inbound protocol close command observed eg. HTTP header: Connection: close.
      • GRACEFUL_USER_CLOSING

        public static final CloseHandler.CloseEvent GRACEFUL_USER_CLOSING
        User initiated close command, depends on the implementation but usually resembles outbound protocol close.
      • CHANNEL_CLOSED_OUTBOUND

        public static final CloseHandler.CloseEvent CHANNEL_CLOSED_OUTBOUND
        Outbound SocketChannel shutdown observed.
      • CHANNEL_CLOSED_INBOUND

        public static final CloseHandler.CloseEvent CHANNEL_CLOSED_INBOUND
        Inbound SocketChannel shutdown observed.
    • Method Detail

      • values

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

        public static CloseHandler.CloseEvent 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