IoUringBufferRingAllocator Type — netty Architecture

Source Code

transport-classes-io_uring/src/main/java/io/netty/channel/uring/IoUringBufferRingAllocator.java lines 25–52

public interface IoUringBufferRingAllocator {

    /**
     * Creates a new receive buffer to use by the buffer ring. The returned {@link ByteBuf} must be direct.
     */
    ByteBuf allocate();

    /**
     * Set the bytes that have been read for the last read operation that was full-filled out of the buffer ring.
     *
     * @param attempted  the attempted bytes to read.
     * @param actual     the number of bytes that could be read.
     */
    void lastBytesRead(int attempted, int actual);

    /**
     * Fill in {@code num} of {@link ByteBuf}s.
     * <strong>Important:</strong> The {@link Consumer} MUST not escape this method.
     *
     * @param consumer  the {@link Consumer} that will consume the buffers.
     * @param num       the number of buffers that are passed to {@link Consumer#accept(Object)}.
     */
    default void allocateBatch(Consumer<ByteBuf> consumer, int num) {
        for (int i = 0; i < num; i++) {
            consumer.accept(allocate());
        }
    }
}