Top Description Fields Constructors Methods
io.netty.channel

public Class ChannelOption<T>

extends AbstractConstant<ChannelOption<T>>
Class Inheritance
Known Direct Subclasses
io.netty.channel.socket.nio.NioChannelOption
Type Parameters
<T>
the type of the value which is valid for the ChannelOption
Imports
io.netty.buffer.ByteBufAllocator, io.netty.util.AbstractConstant, .ConstantPool, io.netty.util.internal.ObjectUtil, java.net.InetAddress, .NetworkInterface
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

Modifier and TypeField and Description
public static final ChannelOption<ByteBufAllocator>
ALLOCATOR

public static final ChannelOption<Boolean>
ALLOW_HALF_CLOSURE

public static final ChannelOption<Boolean>
AUTO_CLOSE

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

public static final ChannelOption<Boolean>
AUTO_READ

public static final ChannelOption<Integer>
CONNECT_TIMEOUT_MILLIS

public static final ChannelOption<Boolean>
DATAGRAM_CHANNEL_ACTIVE_ON_REGISTRATION

Deprecated
public static final ChannelOption<InetAddress>
IP_MULTICAST_ADDR

public static final ChannelOption<NetworkInterface>
IP_MULTICAST_IF

public static final ChannelOption<Boolean>
IP_MULTICAST_LOOP_DISABLED

public static final ChannelOption<Integer>
IP_MULTICAST_TTL

public static final ChannelOption<Integer>
IP_TOS

public static final ChannelOption<Integer>
MAX_MESSAGES_PER_READ

Deprecated Use MaxMessagesRecvByteBufAllocator and MaxMessagesRecvByteBufAllocator#maxMessagesPerRead(int).
public static final ChannelOption<Integer>
MAX_MESSAGES_PER_WRITE

public static final ChannelOption<MessageSizeEstimator>
MESSAGE_SIZE_ESTIMATOR

private static final ConstantPool<ChannelOption<Object>>
pool

public static final ChannelOption<RecvByteBufAllocator>
RCVBUF_ALLOCATOR

public static final ChannelOption<Boolean>
SINGLE_EVENTEXECUTOR_PER_GROUP

public static final ChannelOption<Integer>
SO_BACKLOG

public static final ChannelOption<Boolean>
SO_BROADCAST

public static final ChannelOption<Boolean>
SO_KEEPALIVE

public static final ChannelOption<Integer>
SO_LINGER

public static final ChannelOption<Integer>
SO_RCVBUF

public static final ChannelOption<Boolean>
SO_REUSEADDR

public static final ChannelOption<Integer>
SO_SNDBUF

public static final ChannelOption<Integer>
SO_TIMEOUT

public static final ChannelOption<Integer>
TCP_FASTOPEN

Server-side TCP FastOpen.

public static final ChannelOption<Boolean>
TCP_FASTOPEN_CONNECT

Client-side TCP FastOpen.

public static final ChannelOption<Boolean>
TCP_NODELAY

public static final ChannelOption<Integer>
WRITE_BUFFER_HIGH_WATER_MARK

Deprecated Use WRITE_BUFFER_WATER_MARK
public static final ChannelOption<Integer>
WRITE_BUFFER_LOW_WATER_MARK

Deprecated Use WRITE_BUFFER_WATER_MARK
public static final ChannelOption<WriteBufferWaterMark>
WRITE_BUFFER_WATER_MARK

public static final ChannelOption<Integer>
WRITE_SPIN_COUNT

Constructor Summary

AccessConstructor and Description
private
ChannelOption(int id, String name)

Creates a new ChannelOption with the specified unique name.

protected
ChannelOption(String name)

Deprecated

Method Summary

Modifier and TypeMethod and Description
public static boolean
exists(String name)

Returns true if a ChannelOption exists for the given name.

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.
public void
validate(T value)

Validate the value which is set for the ChannelOption.

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

Returns the ChannelOption of the specified name.

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

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

Inherited from io.netty.util.AbstractConstant:
compareToequalshashCodeidnametoString

Field Detail

ALLOCATORback to summary
public static final ChannelOption<ByteBufAllocator> ALLOCATOR
ALLOW_HALF_CLOSUREback to summary
public static final ChannelOption<Boolean> ALLOW_HALF_CLOSURE
AUTO_CLOSEback to summary
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.

AUTO_READback to summary
public static final ChannelOption<Boolean> AUTO_READ
CONNECT_TIMEOUT_MILLISback to summary
public static final ChannelOption<Integer> CONNECT_TIMEOUT_MILLIS
DATAGRAM_CHANNEL_ACTIVE_ON_REGISTRATIONback to summary
public static final ChannelOption<Boolean> DATAGRAM_CHANNEL_ACTIVE_ON_REGISTRATION

Deprecated

Annotations
@Deprecated
IP_MULTICAST_ADDRback to summary
public static final ChannelOption<InetAddress> IP_MULTICAST_ADDR
IP_MULTICAST_IFback to summary
public static final ChannelOption<NetworkInterface> IP_MULTICAST_IF
IP_MULTICAST_LOOP_DISABLEDback to summary
public static final ChannelOption<Boolean> IP_MULTICAST_LOOP_DISABLED
IP_MULTICAST_TTLback to summary
public static final ChannelOption<Integer> IP_MULTICAST_TTL
IP_TOSback to summary
public static final ChannelOption<Integer> IP_TOS
MAX_MESSAGES_PER_READback to summary
public static final ChannelOption<Integer> MAX_MESSAGES_PER_READ

Deprecated

Use MaxMessagesRecvByteBufAllocator and MaxMessagesRecvByteBufAllocator#maxMessagesPerRead(int).

Annotations
@Deprecated
MAX_MESSAGES_PER_WRITEback to summary
public static final ChannelOption<Integer> MAX_MESSAGES_PER_WRITE
MESSAGE_SIZE_ESTIMATORback to summary
public static final ChannelOption<MessageSizeEstimator> MESSAGE_SIZE_ESTIMATOR
poolback to summary
private static final ConstantPool<ChannelOption<Object>> pool
RCVBUF_ALLOCATORback to summary
public static final ChannelOption<RecvByteBufAllocator> RCVBUF_ALLOCATOR
SINGLE_EVENTEXECUTOR_PER_GROUPback to summary
public static final ChannelOption<Boolean> SINGLE_EVENTEXECUTOR_PER_GROUP
SO_BACKLOGback to summary
public static final ChannelOption<Integer> SO_BACKLOG
SO_BROADCASTback to summary
public static final ChannelOption<Boolean> SO_BROADCAST
SO_KEEPALIVEback to summary
public static final ChannelOption<Boolean> SO_KEEPALIVE
SO_LINGERback to summary
public static final ChannelOption<Integer> SO_LINGER
SO_RCVBUFback to summary
public static final ChannelOption<Integer> SO_RCVBUF
SO_REUSEADDRback to summary
public static final ChannelOption<Boolean> SO_REUSEADDR
SO_SNDBUFback to summary
public static final ChannelOption<Integer> SO_SNDBUF
SO_TIMEOUTback to summary
public static final ChannelOption<Integer> SO_TIMEOUT
TCP_FASTOPENback to summary
public static final ChannelOption<Integer> TCP_FASTOPEN

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

TCP_FASTOPEN_CONNECTback to summary
public static final ChannelOption<Boolean> TCP_FASTOPEN_CONNECT

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

TCP_NODELAYback to summary
public static final ChannelOption<Boolean> TCP_NODELAY
WRITE_BUFFER_HIGH_WATER_MARKback to summary
public static final ChannelOption<Integer> WRITE_BUFFER_HIGH_WATER_MARK

Deprecated

Use WRITE_BUFFER_WATER_MARK

Annotations
@Deprecated
WRITE_BUFFER_LOW_WATER_MARKback to summary
public static final ChannelOption<Integer> WRITE_BUFFER_LOW_WATER_MARK

Deprecated

Use WRITE_BUFFER_WATER_MARK

Annotations
@Deprecated
WRITE_BUFFER_WATER_MARKback to summary
public static final ChannelOption<WriteBufferWaterMark> WRITE_BUFFER_WATER_MARK
WRITE_SPIN_COUNTback to summary
public static final ChannelOption<Integer> WRITE_SPIN_COUNT

Constructor Detail

ChannelOptionback to summary
private ChannelOption(int id, String name)

Creates a new ChannelOption with the specified unique name.

ChannelOptionback to summary
protected ChannelOption(String name)

Deprecated

Annotations
@Deprecated

Method Detail

existsback to summary
public static boolean exists(String name)

Returns true if a ChannelOption exists for the given name.

newInstanceback to summary
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.

Annotations
@Deprecated
@SuppressWarnings:unchecked
validateback to summary
public void validate(T value)

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

valueOfback to summary
public static <T> ChannelOption<T> valueOf(String name)

Returns the ChannelOption of the specified name.

Annotations
@SuppressWarnings:unchecked
valueOfback to summary
public static <T> ChannelOption<T> valueOf(Class<?> firstNameComponent, String secondNameComponent)

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

Annotations
@SuppressWarnings:unchecked