Class ChannelOption<T>

java.lang.Object

io.netty.util.AbstractConstant<ChannelOption<T>>

io.netty.channel.ChannelOption<T>

Type Parameters:

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

All Implemented Interfaces:

Constant<ChannelOption<T>>, Comparable<ChannelOption<T>>

Direct Known Subclasses:

Http2StreamChannelOption, NioChannelOption, QuicChannelOption, RxtxChannelOption, SctpChannelOption, UdtChannelOption, UnixChannelOption

public class ChannelOption<T>
extends AbstractConstant<ChannelOption<T>>

A ChannelOption allows to configure a ChannelConfig in a type-safe way. Which ChannelOption is supported depends on the actual implementation of ChannelConfig and may depend on the nature of the transport it belongs to.

Field Summary

Fields

Modifier and Type	Field	Description
static final ChannelOption<ByteBufAllocator>	ALLOCATOR
static final ChannelOption<Boolean>	ALLOW_HALF_CLOSURE
static final ChannelOption<Boolean>	AUTO_CLOSE	If true then the Channel is closed automatically and immediately on write failure.
static final ChannelOption<Boolean>	AUTO_READ
static final ChannelOption<Integer>	CONNECT_TIMEOUT_MILLIS
static final ChannelOption<Boolean>	DATAGRAM_CHANNEL_ACTIVE_ON_REGISTRATION	Deprecated.
static final ChannelOption<InetAddress>	IP_MULTICAST_ADDR
static final ChannelOption<NetworkInterface>	IP_MULTICAST_IF
static final ChannelOption<Boolean>	IP_MULTICAST_LOOP_DISABLED
static final ChannelOption<Integer>	IP_MULTICAST_TTL
static final ChannelOption<Integer>	IP_TOS
static final ChannelOption<Integer>	MAX_MESSAGES_PER_READ	Deprecated. Use MaxMessagesRecvByteBufAllocator and MaxMessagesRecvByteBufAllocator.maxMessagesPerRead(int).
static final ChannelOption<Integer>	MAX_MESSAGES_PER_WRITE
static final ChannelOption<MessageSizeEstimator>	MESSAGE_SIZE_ESTIMATOR
static final ChannelOption<RecvByteBufAllocator>	RCVBUF_ALLOCATOR	Deprecated. use RECVBUF_ALLOCATOR.
static final ChannelOption<RecvByteBufAllocator>	RECVBUF_ALLOCATOR
static final ChannelOption<Boolean>	SINGLE_EVENTEXECUTOR_PER_GROUP
static final ChannelOption<Integer>	SO_BACKLOG
static final ChannelOption<Boolean>	SO_BROADCAST
static final ChannelOption<Boolean>	SO_KEEPALIVE
static final ChannelOption<Integer>	SO_LINGER
static final ChannelOption<Integer>	SO_RCVBUF
static final ChannelOption<Boolean>	SO_REUSEADDR
static final ChannelOption<Integer>	SO_SNDBUF
static final ChannelOption<Integer>	SO_TIMEOUT
static final ChannelOption<Integer>	TCP_FASTOPEN	Server-side TCP FastOpen.
static final ChannelOption<Boolean>	TCP_FASTOPEN_CONNECT	Client-side TCP FastOpen.
static final ChannelOption<Boolean>	TCP_NODELAY
static final ChannelOption<Integer>	WRITE_BUFFER_HIGH_WATER_MARK	Deprecated. Use WRITE_BUFFER_WATER_MARK
static final ChannelOption<Integer>	WRITE_BUFFER_LOW_WATER_MARK	Deprecated. Use WRITE_BUFFER_WATER_MARK
static final ChannelOption<WriteBufferWaterMark>	WRITE_BUFFER_WATER_MARK
static final ChannelOption<Integer>	WRITE_SPIN_COUNT

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ChannelOption(String name)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static boolean	exists(String name)	Returns true if a ChannelOption exists for the given name.
static <T> ChannelOption<T>	newInstance(String name)	Deprecated. use valueOf(String).
void	validate(T value)	Validate the value which is set for the ChannelOption.
static <T> ChannelOption<T>	valueOf(Class<?> firstNameComponent, String secondNameComponent)	Shortcut of valueOf(firstNameComponent.getName() + "#" + secondNameComponent).
static <T> ChannelOption<T>	valueOf(String name)	Returns the ChannelOption of the specified name.

Methods inherited from class AbstractConstant

compareTo, equals, hashCode, id, name, toString

Methods inherited from class Object

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

Field Details

ALLOCATOR

public static final ChannelOption<ByteBufAllocator> ALLOCATOR

RECVBUF_ALLOCATOR

public static final ChannelOption<RecvByteBufAllocator> RECVBUF_ALLOCATOR

RCVBUF_ALLOCATOR

@Deprecated
public static final ChannelOption<RecvByteBufAllocator> RCVBUF_ALLOCATOR

Deprecated.

use RECVBUF_ALLOCATOR.

MESSAGE_SIZE_ESTIMATOR

public static final ChannelOption<MessageSizeEstimator> MESSAGE_SIZE_ESTIMATOR

CONNECT_TIMEOUT_MILLIS

public static final ChannelOption<Integer> CONNECT_TIMEOUT_MILLIS

MAX_MESSAGES_PER_READ

@Deprecated
public static final ChannelOption<Integer> MAX_MESSAGES_PER_READ

Deprecated.

Use MaxMessagesRecvByteBufAllocator and MaxMessagesRecvByteBufAllocator.maxMessagesPerRead(int).

MAX_MESSAGES_PER_WRITE

public static final ChannelOption<Integer> MAX_MESSAGES_PER_WRITE

WRITE_SPIN_COUNT

public static final ChannelOption<Integer> WRITE_SPIN_COUNT

WRITE_BUFFER_HIGH_WATER_MARK

@Deprecated
public static final ChannelOption<Integer> WRITE_BUFFER_HIGH_WATER_MARK

Deprecated.

Use WRITE_BUFFER_WATER_MARK

WRITE_BUFFER_LOW_WATER_MARK

@Deprecated
public static final ChannelOption<Integer> WRITE_BUFFER_LOW_WATER_MARK

Deprecated.

Use WRITE_BUFFER_WATER_MARK

WRITE_BUFFER_WATER_MARK

public static final ChannelOption<WriteBufferWaterMark> WRITE_BUFFER_WATER_MARK

ALLOW_HALF_CLOSURE

public static final ChannelOption<Boolean> ALLOW_HALF_CLOSURE

AUTO_READ

public static final ChannelOption<Boolean> AUTO_READ

AUTO_CLOSE

public static final ChannelOption<Boolean> AUTO_CLOSE

If true then the Channel is closed automatically and immediately on write failure. The default value is true.

SO_BROADCAST

public static final ChannelOption<Boolean> SO_BROADCAST

SO_KEEPALIVE

public static final ChannelOption<Boolean> SO_KEEPALIVE

SO_SNDBUF

public static final ChannelOption<Integer> SO_SNDBUF

SO_RCVBUF

public static final ChannelOption<Integer> SO_RCVBUF

SO_REUSEADDR

public static final ChannelOption<Boolean> SO_REUSEADDR

SO_LINGER

public static final ChannelOption<Integer> SO_LINGER

SO_BACKLOG

public static final ChannelOption<Integer> SO_BACKLOG

SO_TIMEOUT

public static final ChannelOption<Integer> SO_TIMEOUT

IP_TOS

public static final ChannelOption<Integer> IP_TOS

IP_MULTICAST_ADDR

public static final ChannelOption<InetAddress> IP_MULTICAST_ADDR

IP_MULTICAST_IF

public static final ChannelOption<NetworkInterface> IP_MULTICAST_IF

IP_MULTICAST_TTL

public static final ChannelOption<Integer> IP_MULTICAST_TTL

IP_MULTICAST_LOOP_DISABLED

public static final ChannelOption<Boolean> IP_MULTICAST_LOOP_DISABLED

TCP_NODELAY

public static final ChannelOption<Boolean> TCP_NODELAY

TCP_FASTOPEN_CONNECT

public static final ChannelOption<Boolean> TCP_FASTOPEN_CONNECT

Client-side TCP FastOpen. Sending data with the initial TCP handshake.

TCP_FASTOPEN

public static final ChannelOption<Integer> TCP_FASTOPEN

Server-side TCP FastOpen. Configures the maximum number of outstanding (waiting to be accepted) TFO connections.

DATAGRAM_CHANNEL_ACTIVE_ON_REGISTRATION

@Deprecated
public static final ChannelOption<Boolean> DATAGRAM_CHANNEL_ACTIVE_ON_REGISTRATION

Deprecated.

SINGLE_EVENTEXECUTOR_PER_GROUP

public static final ChannelOption<Boolean> SINGLE_EVENTEXECUTOR_PER_GROUP

Constructor Details

ChannelOption

@Deprecated
protected ChannelOption(String name)

Deprecated.

Method Details

valueOf

public static <T> ChannelOption<T> valueOf(String name)

Returns the ChannelOption of the specified name.

valueOf

public static <T> ChannelOption<T> valueOf(Class<?> firstNameComponent,
 String secondNameComponent)

Shortcut of valueOf(firstNameComponent.getName() + "#" + secondNameComponent).

exists

public static boolean exists(String name)

Returns true if a ChannelOption exists for the given name.

newInstance

@Deprecated
public static <T> ChannelOption<T> newInstance(String name)

Deprecated.

use valueOf(String).

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

validate

public void validate(T value)

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