Interface BufferAllocator.PooledOptionBuilder

Enclosing interface:

BufferAllocator

public static sealed interface BufferAllocator.PooledOptionBuilder

Options for creating pooled buffer allocators.

Method Summary

Modifier and Type	Method	Description
BufferAllocator.PooledOptionBuilder	maxByteBufferCapacity(int capacity)	Sets the maximum capacity, in bytes, that may be requested by BufferAllocator.getByteBuffer(int).
BufferAllocator.PooledOptionBuilder	maxByteBufferPoolCapacity(int capacity)	Sets the maximum capacity of the byte buffer pool.
BufferAllocator.PooledOptionBuilder	maxCharBufferCapacity(int capacity)	Sets the maximum capacity, in chars, that may be requested by BufferAllocator.getCharBuffer(int).
BufferAllocator.PooledOptionBuilder	maxCharBufferPoolCapacity(int capacity)	Sets the maximum capacity of the char buffer pool.
BufferAllocator.PooledOptionBuilder	maxPooledByteBufferCapacity(int capacity)	Sets the maximum capacity, in bytes, of a pooled byte buffer.
BufferAllocator.PooledOptionBuilder	maxPooledCharBufferCapacity(int capacity)	Sets the maximum capacity, in chars, of a pooled char buffer.
BufferAllocator.PooledOptionBuilder	preferDirectBuffers(boolean flag)	Sets whether to preferably allocate direct byte buffers.

Method Details

maxByteBufferCapacity

BufferAllocator.PooledOptionBuilder maxByteBufferCapacity(int capacity)

Sets the maximum capacity, in bytes, that may be requested by BufferAllocator.getByteBuffer(int).

If BufferAllocator.getByteBuffer(int) is called with an argument greater than capacity, MxPackException.SizeLimitExceeded is thrown.

Default: Integer.MAX_VALUE

Parameters:

capacity - the maximum capacity, in bytes, that may be requested by BufferAllocator.getByteBuffer(int)

Returns:

this builder

maxCharBufferCapacity

BufferAllocator.PooledOptionBuilder maxCharBufferCapacity(int capacity)

Sets the maximum capacity, in chars, that may be requested by BufferAllocator.getCharBuffer(int).

If BufferAllocator.getCharBuffer(int) is called with an argument greater than capacity, MxPackException.SizeLimitExceeded is thrown.

Default: Integer.MAX_VALUE

Parameters:

capacity - the maximum capacity, in chars, that may be requested by BufferAllocator.getCharBuffer(int)

Returns:

this builder

maxPooledByteBufferCapacity

BufferAllocator.PooledOptionBuilder maxPooledByteBufferCapacity(int capacity)

Sets the maximum capacity, in bytes, of a pooled byte buffer.

If BufferAllocator.getByteBuffer(int) is called with an argument greater than capacity, an unpooled heap buffer is returned.

Default: 1024 * 1024

Parameters:

capacity - the maximum capacity, in bytes, of a pooled byte buffer

Returns:

this builder

maxPooledCharBufferCapacity

BufferAllocator.PooledOptionBuilder maxPooledCharBufferCapacity(int capacity)

Sets the maximum capacity, in chars, of a pooled char buffer.

If BufferAllocator.getCharBuffer(int) is called with an argument greater than capacity, an unpooled buffer is returned.

Default: 1024 * 512

Parameters:

capacity - the maximum capacity, in chars, of a pooled char buffer

Returns:

this builder

maxByteBufferPoolCapacity

BufferAllocator.PooledOptionBuilder maxByteBufferPoolCapacity(int capacity)

Sets the maximum capacity of the byte buffer pool.

If the byte buffer pool runs out of buffers after the maximum pool capacity has been reached, additional unpooled byte buffers are allocated on the heap.

Default: 1024 * 1024 * 64

Parameters:

capacity - the maximum capacity of the byte buffer pool

Returns:

this builder

maxCharBufferPoolCapacity

BufferAllocator.PooledOptionBuilder maxCharBufferPoolCapacity(int capacity)

Sets the maximum capacity of the char buffer pool.

If the char buffer pool runs out of buffers after the maximum pool capacity has been reached, additional unpooled char buffers are allocated.

Default: 1024 * 1024 * 32

Parameters:

capacity - the maximum capacity of the char buffer pool

Returns:

this builder

preferDirectBuffers

BufferAllocator.PooledOptionBuilder preferDirectBuffers(boolean flag)

Sets whether to preferably allocate direct byte buffers.

If set to true, byte buffers are preferably allocated with ByteBuffer.allocateDirect(int). If set to false, byte buffers are allocated with ByteBuffer.allocate(int).

If the byte buffer pool runs out of buffers after the maximum pool capacity has been reached, additional unpooled buffers are allocated with ByteBuffer.allocate(int) even if this option is set to true.

This option does not apply to char buffers, which are always allocated with CharBuffer.allocate(int).

Default: false

Parameters:

flag - whether to preferably allocate direct byte buffers

Returns:

this builder`