Package io.netty.channel.uring

Class IoUringChannelOption<T>

  • All Implemented Interfaces:
    io.netty.util.Constant<io.netty.channel.ChannelOption<T>>, Comparable<io.netty.channel.ChannelOption<T>>
    public final class IoUringChannelOption<T>
extends io.netty.channel.unix.UnixChannelOption<T>

    • Field Summary

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

      • Fields inherited from class io.netty.channel.unix.UnixChannelOption

        DOMAIN_SOCKET_READ_MODE, SO_REUSEPORT

      • Fields inherited from class io.netty.channel.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 io.netty.channel.ChannelOption

        exists, newInstance, validate, valueOf, valueOf

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

        compareTo, equals, hashCode, id, name, toString

    • Field Detail

      • TCP_CORK

        public static final io.netty.channel.ChannelOption<Boolean> TCP_CORK

      • TCP_NOTSENT_LOWAT

        public static final io.netty.channel.ChannelOption<Long> TCP_NOTSENT_LOWAT

      • TCP_KEEPIDLE

        public static final io.netty.channel.ChannelOption<Integer> TCP_KEEPIDLE

      • TCP_KEEPINTVL

        public static final io.netty.channel.ChannelOption<Integer> TCP_KEEPINTVL

      • TCP_KEEPCNT

        public static final io.netty.channel.ChannelOption<Integer> TCP_KEEPCNT

      • TCP_USER_TIMEOUT

        public static final io.netty.channel.ChannelOption<Integer> TCP_USER_TIMEOUT

      • IP_FREEBIND

        public static final io.netty.channel.ChannelOption<Boolean> IP_FREEBIND

      • IP_TRANSPARENT

        public static final io.netty.channel.ChannelOption<Boolean> IP_TRANSPARENT

      • TCP_FASTOPEN

        public static final io.netty.channel.ChannelOption<Integer> TCP_FASTOPEN
        Deprecated.
        Use ChannelOption.TCP_FASTOPEN instead.

      • TCP_DEFER_ACCEPT

        public static final io.netty.channel.ChannelOption<Integer> TCP_DEFER_ACCEPT

      • TCP_QUICKACK

        public static final io.netty.channel.ChannelOption<Boolean> TCP_QUICKACK

      • MAX_DATAGRAM_PAYLOAD_SIZE

        public static final io.netty.channel.ChannelOption<Integer> MAX_DATAGRAM_PAYLOAD_SIZE

      • IO_URING_BUFFER_GROUP_ID

        public static final io.netty.channel.ChannelOption<Short> IO_URING_BUFFER_GROUP_ID
        If {@param positive} 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 io.netty.channel.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 io.netty.channel.ChannelOption<Boolean> IP_MULTICAST_ALL