View Javadoc
1   /*
2    * Copyright 2025 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.buffer.ByteBufAllocator;
19  import io.netty.util.internal.ObjectUtil;
20  
21  
22  /**
23   * {@link IoUringBufferRingAllocator} implementation which uses a fixed size for the buffers that are returned by
24   * {@link #allocate()}.
25   */
26  public final class IoUringFixedBufferRingAllocator extends AbstractIoUringBufferRingAllocator {
27      private final int bufferSize;
28  
29      /**
30       * Create a new instance
31       *
32       * @param allocator         the {@link ByteBufAllocator} to use.
33       * @param largeAllocation   {@code true} if we should do a large allocation for the whole buffer ring
34       *                          and then slice out the buffers or {@code false} if we should do one allocation
35       *                          per buffer.
36       * @param bufferSize        the size of the buffers that are allocated.
37       */
38      public IoUringFixedBufferRingAllocator(ByteBufAllocator allocator, boolean largeAllocation, int bufferSize) {
39          super(allocator, largeAllocation);
40          this.bufferSize = ObjectUtil.checkPositive(bufferSize, "bufferSize");
41      }
42  
43      /**
44       * Create a new instance
45       *
46       * @param allocator     the {@link ByteBufAllocator} to use.
47       * @param bufferSize    the size of the buffers that are allocated.
48       */
49      public IoUringFixedBufferRingAllocator(ByteBufAllocator allocator, int bufferSize) {
50          this(allocator, false, bufferSize);
51      }
52  
53      /**
54       * Create a new instance
55       *
56       * @param bufferSize    the size of the buffers that are allocated.
57       */
58      public IoUringFixedBufferRingAllocator(int bufferSize) {
59          this(ByteBufAllocator.DEFAULT, bufferSize);
60      }
61  
62      @Override
63      protected int nextBufferSize() {
64          return bufferSize;
65      }
66  }