Class IoUringChannelOption<T>

java.lang.Object

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

io.netty.channel.ChannelOption<T>

io.netty.channel.unix.UnixChannelOption<T>

io.netty.channel.uring.IoUringChannelOption<T>

All Implemented Interfaces:

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

public final class IoUringChannelOption<T>
extends UnixChannelOption<T>

Field Summary

Fields

Modifier and Type	Field	Description
static final ChannelOption<Short>	IO_URING_BUFFER_GROUP_ID	If try to use a buffer ring when submitting recv / read / readv IoUringIoOps.
static final ChannelOption<Integer>	IO_URING_WRITE_ZERO_COPY_THRESHOLD	The threshold for zero-copy write (send_zc and sendmsg_zc).
static final ChannelOption<Boolean>	IP_FREEBIND
static final ChannelOption<Boolean>	IP_MULTICAST_ALL
static final ChannelOption<Boolean>	IP_TRANSPARENT
static final ChannelOption<Integer>	MAX_DATAGRAM_PAYLOAD_SIZE
static final ChannelOption<Boolean>	TCP_CORK
static final ChannelOption<Integer>	TCP_DEFER_ACCEPT
static final ChannelOption<Integer>	TCP_FASTOPEN	Deprecated. Use ChannelOption.TCP_FASTOPEN instead.
static final ChannelOption<Integer>	TCP_KEEPCNT
static final ChannelOption<Integer>	TCP_KEEPIDLE
static final ChannelOption<Integer>	TCP_KEEPINTVL
static final ChannelOption<Long>	TCP_NOTSENT_LOWAT
static final ChannelOption<Boolean>	TCP_QUICKACK
static final ChannelOption<Integer>	TCP_USER_TIMEOUT

Fields inherited from class UnixChannelOption

DOMAIN_SOCKET_READ_MODE, SO_REUSEPORT

Fields inherited from class ChannelOption

ALLOCATOR, ALLOW_HALF_CLOSURE, AUTO_CLOSE, AUTO_READ, CONNECT_TIMEOUT_MILLIS, DATAGRAM_CHANNEL_ACTIVE_ON_REGISTRATION, IP_MULTICAST_ADDR, IP_MULTICAST_IF, IP_MULTICAST_LOOP_DISABLED, IP_MULTICAST_TTL, IP_TOS, MAX_MESSAGES_PER_READ, MAX_MESSAGES_PER_WRITE, MESSAGE_SIZE_ESTIMATOR, RCVBUF_ALLOCATOR, RECVBUF_ALLOCATOR, SINGLE_EVENTEXECUTOR_PER_GROUP, SO_BACKLOG, SO_BROADCAST, SO_KEEPALIVE, SO_LINGER, SO_RCVBUF, SO_REUSEADDR, SO_SNDBUF, SO_TIMEOUT, TCP_FASTOPEN_CONNECT, TCP_NODELAY, WRITE_BUFFER_HIGH_WATER_MARK, WRITE_BUFFER_LOW_WATER_MARK, WRITE_BUFFER_WATER_MARK, WRITE_SPIN_COUNT

Method Summary

Methods inherited from class ChannelOption

exists, newInstance, validate, valueOf, valueOf

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

TCP_CORK

public static final ChannelOption<Boolean> TCP_CORK

TCP_NOTSENT_LOWAT

public static final ChannelOption<Long> TCP_NOTSENT_LOWAT

TCP_KEEPIDLE

public static final ChannelOption<Integer> TCP_KEEPIDLE

TCP_KEEPINTVL

public static final ChannelOption<Integer> TCP_KEEPINTVL

TCP_KEEPCNT

public static final ChannelOption<Integer> TCP_KEEPCNT

TCP_USER_TIMEOUT

public static final ChannelOption<Integer> TCP_USER_TIMEOUT

IP_FREEBIND

public static final ChannelOption<Boolean> IP_FREEBIND

IP_TRANSPARENT

public static final ChannelOption<Boolean> IP_TRANSPARENT

TCP_FASTOPEN

public static final ChannelOption<Integer> TCP_FASTOPEN

Deprecated.

Use ChannelOption.TCP_FASTOPEN instead.

TCP_DEFER_ACCEPT

public static final ChannelOption<Integer> TCP_DEFER_ACCEPT

TCP_QUICKACK

public static final ChannelOption<Boolean> TCP_QUICKACK

MAX_DATAGRAM_PAYLOAD_SIZE

public static final ChannelOption<Integer> MAX_DATAGRAM_PAYLOAD_SIZE

IO_URING_BUFFER_GROUP_ID

public static final ChannelOption<Short> IO_URING_BUFFER_GROUP_ID

If try to use a buffer ring when submitting recv / read / readv IoUringIoOps. If it is set to -1, no buffer ring will be used. Be aware that you can only change the group before the channel is registered.

Check man io_uring_setup_buf_ring and this LWN article for more details.

IO_URING_WRITE_ZERO_COPY_THRESHOLD

public static final ChannelOption<Integer> IO_URING_WRITE_ZERO_COPY_THRESHOLD

The threshold for zero-copy write (send_zc and sendmsg_zc). If it is set to -1, then this function will be disabled.

If the locked memory limit is too low you will observe -ENOMEM and writes will be failed. This is a clear sign that you should increase the locked memory limit via ulimit -l.

Check man io_uring_enter for more details.

IP_MULTICAST_ALL

public static final ChannelOption<Boolean> IP_MULTICAST_ALL