View Javadoc
1   /*
2    * Copyright 2024 The Netty Project
3    *
4    * The Netty Project licenses this file to you under the Apache License,
5    * version 2.0 (the "License"); you may not use this file except in compliance
6    * with the License. You may obtain a copy of the License at:
7    *
8    *   https://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations
14   * under the License.
15   */
16  package io.netty.channel.uring;
17  
18  import io.netty.channel.ChannelOption;
19  import io.netty.channel.unix.UnixChannelOption;
20  
21  public final class IoUringChannelOption<T> extends UnixChannelOption<T> {
22  
23      private IoUringChannelOption() { }
24  
25      public static final ChannelOption<Boolean> TCP_CORK = valueOf(IoUringChannelOption.class, "TCP_CORK");
26      public static final ChannelOption<Long> TCP_NOTSENT_LOWAT =
27              valueOf(IoUringChannelOption.class, "TCP_NOTSENT_LOWAT");
28      public static final ChannelOption<Integer> TCP_KEEPIDLE = valueOf(IoUringChannelOption.class, "TCP_KEEPIDLE");
29      public static final ChannelOption<Integer> TCP_KEEPINTVL = valueOf(IoUringChannelOption.class, "TCP_KEEPINTVL");
30      public static final ChannelOption<Integer> TCP_KEEPCNT = valueOf(IoUringChannelOption.class, "TCP_KEEPCNT");
31      public static final ChannelOption<Integer> TCP_USER_TIMEOUT =
32              valueOf(IoUringChannelOption.class, "TCP_USER_TIMEOUT");
33      public static final ChannelOption<Boolean> IP_FREEBIND = valueOf("IP_FREEBIND");
34      public static final ChannelOption<Boolean> IP_TRANSPARENT = valueOf("IP_TRANSPARENT");
35      /**
36       * @deprecated Use {@link ChannelOption#TCP_FASTOPEN} instead.
37       */
38      public static final ChannelOption<Integer> TCP_FASTOPEN = ChannelOption.TCP_FASTOPEN;
39  
40      public static final ChannelOption<Integer> TCP_DEFER_ACCEPT =
41              ChannelOption.valueOf(IoUringChannelOption.class, "TCP_DEFER_ACCEPT");
42      public static final ChannelOption<Boolean> TCP_QUICKACK = valueOf(IoUringChannelOption.class, "TCP_QUICKACK");
43  
44      public static final ChannelOption<Integer> MAX_DATAGRAM_PAYLOAD_SIZE = valueOf("MAX_DATAGRAM_PAYLOAD_SIZE");
45  
46      /**
47       * If {@param positive} try to use a buffer ring when submitting recv / read / readv {@link IoUringIoOps}.
48       * If it is set to {@code -1}, no buffer ring will be used. Be aware that you can only change the group
49       * before the channel is registered.
50       * <p>
51       * Check
52       * <a href="https://man7.org/linux/man-pages/man3/io_uring_setup_buf_ring.3.html"> man io_uring_setup_buf_ring</a>
53       * and this <a href="https://lwn.net/Articles/815491/">LWN article</a> for more details.
54       */
55      public static final ChannelOption<Short> IO_URING_BUFFER_GROUP_ID =
56              ChannelOption.valueOf(IoUringChannelOption.class, "IO_URING_BUFFER_GROUP_ID");
57  
58  }