IoUringBufferRingConfig Class — netty Architecture

Source Code

transport-classes-io_uring/src/main/java/io/netty/channel/uring/IoUringBufferRingConfig.java lines 28–274

public final class IoUringBufferRingConfig {
    private final short bgId;
    private final short bufferRingSize;
    private final int batchSize;
    private final int maxUnreleasedBuffers;
    private final boolean incremental;
    private final IoUringBufferRingAllocator allocator;
    private final boolean batchAllocation;

    /**
     * Create a new configuration.
     *
     * @param bgId                  the buffer group id to use (must be non-negative).
     * @param bufferRingSize        the size of the ring
     * @param maxUnreleasedBuffers  this parameter is ignored by the buffer ring.
     * @param allocator             the {@link IoUringBufferRingAllocator} to use to allocate
     *                              {@link io.netty.buffer.ByteBuf}s.
     * @deprecated                  use {@link Builder}.
     */
    @Deprecated
    public IoUringBufferRingConfig(short bgId, short bufferRingSize, int maxUnreleasedBuffers,
                                   IoUringBufferRingAllocator allocator) {
        this(bgId, bufferRingSize, bufferRingSize / 2, maxUnreleasedBuffers,
                IoUring.isRegisterBufferRingIncSupported(), allocator);
    }

    /**
     * Create a new configuration.
     *
     * @param bgId                  the buffer group id to use (must be non-negative).
     * @param bufferRingSize        the size of the ring
     * @param batchSize             the size of the batch on how many buffers are added everytime we need to expand the
     *                              buffer ring.
     * @param maxUnreleasedBuffers  this parameter is ignored by the buffer ring.
     * @param incremental           {@code true} if the buffer ring is using incremental buffer consumption.
     * @param allocator             the {@link IoUringBufferRingAllocator} to use to allocate
     *                              {@link io.netty.buffer.ByteBuf}s.
     * @deprecated                  use {@link Builder}.
     */
    @Deprecated
    public IoUringBufferRingConfig(short bgId, short bufferRingSize, int batchSize, int maxUnreleasedBuffers,
                                   boolean incremental, IoUringBufferRingAllocator allocator) {
        this(bgId, bufferRingSize, batchSize, maxUnreleasedBuffers, incremental, allocator, false);
    }

    private IoUringBufferRingConfig(short bgId, short bufferRingSize, int batchSize, int maxUnreleasedBuffers,
                                   boolean incremental, IoUringBufferRingAllocator allocator, boolean batchAllocation) {
        this.bgId = (short) ObjectUtil.checkPositiveOrZero(bgId, "bgId");
        this.bufferRingSize = checkBufferRingSize(bufferRingSize);
        this.batchSize = MathUtil.findNextPositivePowerOfTwo(
                ObjectUtil.checkInRange(batchSize, 1, bufferRingSize, "batchSize"));
        this.maxUnreleasedBuffers = ObjectUtil.checkInRange(
                maxUnreleasedBuffers, bufferRingSize, Integer.MAX_VALUE, "maxUnreleasedBuffers");
        if (incremental && !IoUring.isRegisterBufferRingIncSupported()) {
            throw new IllegalArgumentException("Incremental buffer ring is not supported");
        }
        this.incremental = incremental;
        this.allocator = ObjectUtil.checkNotNull(allocator, "allocator");
        this.batchAllocation = batchAllocation;
    }

    /**
     * Returns the buffer group id to use.
     *
     * @return the buffer group id to use.
     */
    public short bufferGroupId() {
        return bgId;
    }

    /**
     * Returns the size of the ring.
     *
     * @return the size of the ring.
     */
    public short bufferRingSize() {
        return bufferRingSize;
    }

    /**
     * Returns the size of the batch on how many buffers are added everytime we need to expand the buffer ring.