java.lang.Object
- io.netty5.util.AbstractConstant<ChannelOption<T>>
- - io.netty5.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:

NioChannelOption, UnixChannelOption
```
public class ChannelOption<T>
extends AbstractConstant<ChannelOption<T>>
```
A ChannelOption allows to configure a Channel in a type-safe way. Which ChannelOption is supported depends on the actual implementation of Channel and may depend on the nature of the transport it belongs to.

Field Summary

Fields
Modifier and Type	Field	Description
`static ChannelOption<Boolean>`	`ALLOW_HALF_CLOSURE`
`static ChannelOption<Boolean>`	`AUTO_CLOSE`	If `true` then the `Channel` is closed automatically and immediately on write failure.
`static ChannelOption<Boolean>`	`AUTO_READ`
`static ChannelOption<BufferAllocator>`	`BUFFER_ALLOCATOR`
`static ChannelOption<Integer>`	`CONNECT_TIMEOUT_MILLIS`
`static ChannelOption<Boolean>`	`DATAGRAM_CHANNEL_ACTIVE_ON_REGISTRATION`
`static ChannelOption<NetworkInterface>`	`IP_MULTICAST_IF`
`static ChannelOption<Boolean>`	`IP_MULTICAST_LOOP_DISABLED`
`static ChannelOption<Integer>`	`IP_MULTICAST_TTL`
`static ChannelOption<Integer>`	`IP_TOS`
`static ChannelOption<Integer>`	`MAX_MESSAGES_PER_READ`	Deprecated. Use `MaxMessagesRecvBufferAllocator` and `MaxMessagesRecvBufferAllocator.maxMessagesPerRead(int)`.
`static ChannelOption<Integer>`	`MAX_MESSAGES_PER_WRITE`
`static ChannelOption<MessageSizeEstimator>`	`MESSAGE_SIZE_ESTIMATOR`
`static ChannelOption<RecvBufferAllocator>`	`RCVBUFFER_ALLOCATOR`
`static ChannelOption<Integer>`	`SO_BACKLOG`
`static ChannelOption<Boolean>`	`SO_BROADCAST`
`static ChannelOption<Boolean>`	`SO_KEEPALIVE`
`static ChannelOption<Integer>`	`SO_LINGER`
`static ChannelOption<Integer>`	`SO_RCVBUF`
`static ChannelOption<Boolean>`	`SO_REUSEADDR`
`static ChannelOption<Integer>`	`SO_SNDBUF`
`static ChannelOption<Integer>`	`SO_TIMEOUT`
`static ChannelOption<Integer>`	`TCP_FASTOPEN`	Server-side TCP FastOpen.
`static ChannelOption<Boolean>`	`TCP_FASTOPEN_CONNECT`	Client-side TCP FastOpen.
`static ChannelOption<Boolean>`	`TCP_NODELAY`
`static ChannelOption<WriteBufferWaterMark>`	`WRITE_BUFFER_WATER_MARK`
`static ChannelOption<Integer>`	`WRITE_SPIN_COUNT`

Constructor Summary

Constructors
Modifier Constructor Description

protected ChannelOption(String name)
Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
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 io.netty5.util.AbstractConstant
compareTo, equals, hashCode, id, name, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

BUFFER_ALLOCATOR

public static final ChannelOption<BufferAllocator> BUFFER_ALLOCATOR

RCVBUFFER_ALLOCATOR

public static final ChannelOption<RecvBufferAllocator> RCVBUFFER_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 MaxMessagesRecvBufferAllocator and MaxMessagesRecvBufferAllocator.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_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_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

public static final ChannelOption<Boolean> DATAGRAM_CHANNEL_ACTIVE_ON_REGISTRATION

Constructor Detail

ChannelOption

@Deprecated
protected ChannelOption(String name)

Deprecated.

Method Detail
- 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.

Class ChannelOption<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class io.netty5.util.AbstractConstant

Methods inherited from class java.lang.Object

Field Detail

BUFFER_ALLOCATOR

RCVBUFFER_ALLOCATOR

MESSAGE_SIZE_ESTIMATOR

CONNECT_TIMEOUT_MILLIS

MAX_MESSAGES_PER_READ

MAX_MESSAGES_PER_WRITE

WRITE_SPIN_COUNT

WRITE_BUFFER_WATER_MARK

ALLOW_HALF_CLOSURE

AUTO_READ

AUTO_CLOSE

SO_BROADCAST

SO_KEEPALIVE

SO_SNDBUF

SO_RCVBUF

SO_REUSEADDR

SO_LINGER

SO_BACKLOG

SO_TIMEOUT

IP_TOS

IP_MULTICAST_IF

IP_MULTICAST_TTL

IP_MULTICAST_LOOP_DISABLED

TCP_NODELAY

TCP_FASTOPEN_CONNECT

TCP_FASTOPEN

DATAGRAM_CHANNEL_ACTIVE_ON_REGISTRATION

Constructor Detail

ChannelOption

Method Detail

valueOf

valueOf

exists

newInstance

validate