Type Parameters:

T - the type of the value which is valid for the ChannelOption

All Implemented Interfaces:

java.lang.Comparable<UniqueName>

Direct Known Subclasses:

EpollChannelOption, RxtxChannelOption, SctpChannelOption, UdtChannelOption

public class ChannelOption<T>
extends UniqueName 

• Field Summary

  Fields

  Modifier and Type	Field and Description
  static ChannelOption<java.lang.Long>	AIO_READ_TIMEOUT Deprecated.
  static ChannelOption<java.lang.Long>	AIO_WRITE_TIMEOUT Deprecated.
  static ChannelOption<ByteBufAllocator>	ALLOCATOR
  static ChannelOption<java.lang.Boolean>	ALLOW_HALF_CLOSURE
  static ChannelOption<java.lang.Boolean>	AUTO_CLOSE Deprecated. Auto close will be removed in a future release. If true then the Channel is closed automatically and immediately on write failure. The default value is true.
  static ChannelOption<java.lang.Boolean>	AUTO_READ
  static ChannelOption<java.lang.Integer>	CONNECT_TIMEOUT_MILLIS
  static ChannelOption<java.lang.Boolean>	DATAGRAM_CHANNEL_ACTIVE_ON_REGISTRATION Deprecated.
  static ChannelOption<java.net.InetAddress>	IP_MULTICAST_ADDR
  static ChannelOption<java.net.NetworkInterface>	IP_MULTICAST_IF
  static ChannelOption<java.lang.Boolean>	IP_MULTICAST_LOOP_DISABLED
  static ChannelOption<java.lang.Integer>	IP_MULTICAST_TTL
  static ChannelOption<java.lang.Integer>	IP_TOS
  static ChannelOption<java.lang.Integer>	MAX_MESSAGES_PER_READ
  static ChannelOption<MessageSizeEstimator>	MESSAGE_SIZE_ESTIMATOR
  static ChannelOption<RecvByteBufAllocator>	RCVBUF_ALLOCATOR
  static ChannelOption<java.lang.Boolean>	SINGLE_EVENTEXECUTOR_PER_GROUP
  static ChannelOption<java.lang.Integer>	SO_BACKLOG
  static ChannelOption<java.lang.Boolean>	SO_BROADCAST
  static ChannelOption<java.lang.Boolean>	SO_KEEPALIVE
  static ChannelOption<java.lang.Integer>	SO_LINGER
  static ChannelOption<java.lang.Integer>	SO_RCVBUF
  static ChannelOption<java.lang.Boolean>	SO_REUSEADDR
  static ChannelOption<java.lang.Integer>	SO_SNDBUF
  static ChannelOption<java.lang.Integer>	SO_TIMEOUT
  static ChannelOption<java.lang.Boolean>	TCP_NODELAY
  static ChannelOption<java.lang.Integer>	WRITE_BUFFER_HIGH_WATER_MARK
  static ChannelOption<java.lang.Integer>	WRITE_BUFFER_LOW_WATER_MARK
  static ChannelOption<java.lang.Integer>	WRITE_SPIN_COUNT

• Constructor Summary

  Constructors

  Modifier	Constructor and Description
  protected	ChannelOption (java.lang.String name) Deprecated. Use valueOf(String) instead.

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  static boolean	exists (java.lang.String name) Returns true if a ChannelOption exists for the given name.
  static <T> ChannelOption<T>	newInstance (java.lang.String name) Creates a new ChannelOption for the given or fail with an IllegalArgumentException if a ChannelOption for the given exists.
  void	validate (T value) Validate the value which is set for the ChannelOption.
  static <T> ChannelOption<T>	valueOf (java.lang.String name) Creates a new ChannelOption with the specified or return the already existing ChannelOption for the given name.

  • Methods inherited from class io.netty.util.UniqueName

    compareTo, equals, hashCode, id, name, toString, validateArgs

  • Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

• Field Detail

  • ALLOCATOR

    public static final ChannelOption<ByteBufAllocator> ALLOCATOR

  • RCVBUF_ALLOCATOR

    public static final ChannelOption<RecvByteBufAllocator> RCVBUF_ALLOCATOR

  • MESSAGE_SIZE_ESTIMATOR

    public static final ChannelOption<MessageSizeEstimator> MESSAGE_SIZE_ESTIMATOR

  • CONNECT_TIMEOUT_MILLIS

    public static final ChannelOption<java.lang.Integer> CONNECT_TIMEOUT_MILLIS

  • MAX_MESSAGES_PER_READ

    public static final ChannelOption<java.lang.Integer> MAX_MESSAGES_PER_READ

  • WRITE_SPIN_COUNT

    public static final ChannelOption<java.lang.Integer> WRITE_SPIN_COUNT

  • WRITE_BUFFER_HIGH_WATER_MARK

    public static final ChannelOption<java.lang.Integer> WRITE_BUFFER_HIGH_WATER_MARK

  • WRITE_BUFFER_LOW_WATER_MARK

    public static final ChannelOption<java.lang.Integer> WRITE_BUFFER_LOW_WATER_MARK

  • ALLOW_HALF_CLOSURE

    public static final ChannelOption<java.lang.Boolean> ALLOW_HALF_CLOSURE

  • AUTO_READ

    public static final ChannelOption<java.lang.Boolean> AUTO_READ

  • AUTO_CLOSE

    @Deprecated
    public static final ChannelOption<java.lang.Boolean> AUTO_CLOSE

    Deprecated. Auto close will be removed in a future release. If true then the Channel is closed automatically and immediately on write failure. The default value is true.

  • SO_BROADCAST

    public static final ChannelOption<java.lang.Boolean> SO_BROADCAST

  • SO_KEEPALIVE

    public static final ChannelOption<java.lang.Boolean> SO_KEEPALIVE

  • SO_SNDBUF

    public static final ChannelOption<java.lang.Integer> SO_SNDBUF

  • SO_RCVBUF

    public static final ChannelOption<java.lang.Integer> SO_RCVBUF

  • SO_REUSEADDR

    public static final ChannelOption<java.lang.Boolean> SO_REUSEADDR

  • SO_LINGER

    public static final ChannelOption<java.lang.Integer> SO_LINGER

  • SO_BACKLOG

    public static final ChannelOption<java.lang.Integer> SO_BACKLOG

  • SO_TIMEOUT

    public static final ChannelOption<java.lang.Integer> SO_TIMEOUT

  • IP_TOS

    public static final ChannelOption<java.lang.Integer> IP_TOS

  • IP_MULTICAST_ADDR

    public static final ChannelOption<java.net.InetAddress> IP_MULTICAST_ADDR

  • IP_MULTICAST_IF

    public static final ChannelOption<java.net.NetworkInterface> IP_MULTICAST_IF

  • IP_MULTICAST_TTL

    public static final ChannelOption<java.lang.Integer> IP_MULTICAST_TTL

  • IP_MULTICAST_LOOP_DISABLED

    public static final ChannelOption<java.lang.Boolean> IP_MULTICAST_LOOP_DISABLED

  • TCP_NODELAY

    public static final ChannelOption<java.lang.Boolean> TCP_NODELAY

  • AIO_READ_TIMEOUT

    @Deprecated
    public static final ChannelOption<java.lang.Long> AIO_READ_TIMEOUT

    Deprecated.

  • AIO_WRITE_TIMEOUT

    @Deprecated
    public static final ChannelOption<java.lang.Long> AIO_WRITE_TIMEOUT

    Deprecated.

  • DATAGRAM_CHANNEL_ACTIVE_ON_REGISTRATION

    @Deprecated
    public static final ChannelOption<java.lang.Boolean> DATAGRAM_CHANNEL_ACTIVE_ON_REGISTRATION

    Deprecated.

  • SINGLE_EVENTEXECUTOR_PER_GROUP

    public static final ChannelOption<java.lang.Boolean> SINGLE_EVENTEXECUTOR_PER_GROUP

• Constructor Detail

  • ChannelOption

    @Deprecated
    protected ChannelOption(java.lang.String name)

    Deprecated. Use valueOf(String) instead.

• Method Detail

  • valueOf

    public static <T> ChannelOption<T> valueOf(java.lang.String name)

    Creates a new ChannelOption with the specified or return the already existing ChannelOption for the given name.

  • exists

    public static boolean exists(java.lang.String name)

    Returns true if a ChannelOption exists for the given name.

  • newInstance

    public static <T> ChannelOption<T> newInstance(java.lang.String name)

    Creates a new ChannelOption for the given or fail with an IllegalArgumentException if a ChannelOption for the given exists.

  • validate

    public void validate(T value)

    Validate the value which is set for the ChannelOption. Sub-classes may override this for special checks.