Enum ChannelState

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

    public enum ChannelState
    extends java.lang.Enum<ChannelState>
    The current or future state of a Channel.

    The state of a Channel is interpreted differently depending on the value of a ChannelStateEvent and the direction of the event in a ChannelPipeline:

    DirectionStateValueMeaning
    UpstreamOPEN trueThe channel is open.
    UpstreamOPEN falseThe channel is closed.
    UpstreamBOUND SocketAddressThe channel is bound to a local address.
    UpstreamBOUND nullThe channel is unbound to a local address.
    UpstreamCONNECTED SocketAddressThe channel is connected to a remote address.
    UpstreamCONNECTED nullThe channel is disconnected from a remote address.
    UpstreamINTEREST_OPS an integerThe channel interestOps has been changed.
    DownstreamOPEN trueN/A
    DownstreamOPEN falseClose the channel.
    DownstreamBOUND SocketAddressBind the channel to the specified local address.
    DownstreamBOUND nullUnbind the channel from the current local address.
    DownstreamCONNECTED SocketAddressConnect the channel to the specified remote address.
    DownstreamCONNECTED nullDisconnect the channel from the current remote address.
    DownstreamINTEREST_OPS an integerChange the interestOps of the channel.

    To see how an event is interpreted further, please refer to ChannelEvent.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private ChannelState()  
    • Method Summary

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

      • ChannelState

        private ChannelState()
    • Method Detail

      • values

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

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