Netty5/Buffer 5.0.0.Alpha5 · io.netty5.buffer.ManagedBufferAllocator

Modifier and Type	Field and Description
private final AllocationType	allocationType
private volatile boolean	closed
private final MemoryManager	manager

Access	Constructor and Description
pack-priv	ManagedBufferAllocator(MemoryManager manager, boolean direct)

Method Summary

Modifier and Type	Method and Description
public Buffer	allocate(int The size of `Buffer` to allocate. size) Implements io.netty5.buffer.BufferAllocator.allocate. Allocate a `Buffer` of the given size in bytes.
public void	close() Implements io.netty5.buffer.BufferAllocator.close. Close this allocator, freeing all of its internal resources.
public Supplier<Buffer>	constBufferSupplier(byte[] The byte contents of the buffers produced by the returned supplier. bytes) Implements io.netty5.buffer.BufferAllocator.constBufferSupplier. Create a supplier of "constant" Buffers from this allocator, that all have the given byte contents.
public Buffer	copyOf(String The `String` that determines the size and contents of the new buffer. str, Charset The `Charset` that determines how to turn the string into a sequence of bytes. charset) Overrides default io.netty5.buffer.BufferAllocator.copyOf. Allocate a `Buffer` with the same size and contents of the given `String`, when interpreted as a sequence of bytes with the given `Charset`.
public AllocationType	getAllocationType() Implements io.netty5.buffer.BufferAllocator.getAllocationType. Get the `AllocationType` from this allocator.
public BufferAllocator	getAllocator() Implements io.netty5.buffer.AllocatorControl.getAllocator. Get the `BufferAllocator` instance that is the source of this allocator control.
public boolean	isPooling() Implements io.netty5.buffer.BufferAllocator.isPooling. Determine if this allocator is pooling and reusing its allocated memory.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

allocationType	back to summary
private final AllocationType allocationType

closed	back to summary
private volatile boolean closed

manager	back to summary
private final MemoryManager manager

ManagedBufferAllocator	back to summary
pack-priv ManagedBufferAllocator(MemoryManager manager, boolean direct)

Method Detail

allocate back to summary

allocate	back to summary
public Buffer allocate(int size) Implements io.netty5.buffer.BufferAllocator.allocate. Doc from io.netty5.buffer.BufferAllocator.allocate. Allocate a `Buffer` of the given size in bytes. This method may throw an `OutOfMemoryError` if there is not enough free memory available to allocate a `Buffer` of the requested size. The buffer will use big endian byte order. Note unlike the JDK `ByteBuffer`s, Netty `Buffers` are not guaranteed to be zeroed when allocated. In other words, the memory of a newly allocated buffer may contain garbage data from prior allocations, and the memory is likewise not guaranteed to be erased when the buffer is closed. If the data is sensitive and needs to be overwritten when the buffer is closed, then the buffer should be allocated with the `SensitiveBufferAllocator`. Parameters size:int The size of `Buffer` to allocate. Returns:Buffer The newly allocated `Buffer`. Annotations @Override

public Buffer allocate(int size)

Implements io.netty5.buffer.BufferAllocator.allocate.

Doc from io.netty5.buffer.BufferAllocator.allocate.

Allocate a Buffer of the given size in bytes. This method may throw an OutOfMemoryError if there is not enough free memory available to allocate a Buffer of the requested size.

The buffer will use big endian byte order.

Note

unlike the JDK ByteBuffers, Netty Buffers are not guaranteed to be zeroed when allocated. In other words, the memory of a newly allocated buffer may contain garbage data from prior allocations, and the memory is likewise not guaranteed to be erased when the buffer is closed. If the data is sensitive and needs to be overwritten when the buffer is closed, then the buffer should be allocated with the SensitiveBufferAllocator.

Parameters

size:int: The size of Buffer to allocate.

Returns:Buffer

The newly allocated Buffer.

Annotations

@Override

close back to summary

close	back to summary
public void close() Implements io.netty5.buffer.BufferAllocator.close. Doc from io.netty5.buffer.BufferAllocator.close. Close this allocator, freeing all of its internal resources. Existing (currently in-use) allocated buffers will not be impacted by calling this method. If this is a pooling or caching allocator, then existing buffers will be immediately freed when they are closed, instead of being pooled or cached. The allocator can no longer be used to allocate more buffers after calling this method. Attempting to allocate from a closed allocator will cause `IllegalStateException`s to be thrown. Annotations @Override

public void close()

Implements io.netty5.buffer.BufferAllocator.close.

Doc from io.netty5.buffer.BufferAllocator.close.

Close this allocator, freeing all of its internal resources.

Existing (currently in-use) allocated buffers will not be impacted by calling this method. If this is a pooling or caching allocator, then existing buffers will be immediately freed when they are closed, instead of being pooled or cached.

The allocator can no longer be used to allocate more buffers after calling this method. Attempting to allocate from a closed allocator will cause IllegalStateExceptions to be thrown.

Annotations

@Override

constBufferSupplier back to summary

constBufferSupplier	back to summary
public Supplier<Buffer> constBufferSupplier(byte[] bytes) Implements io.netty5.buffer.BufferAllocator.constBufferSupplier. Doc from io.netty5.buffer.BufferAllocator.constBufferSupplier. Create a supplier of "constant" Buffers from this allocator, that all have the given byte contents. The buffer has the same capacity as the byte array length, and its write offset is placed at the end, and its read offset is at the beginning, such that the entire buffer contents are readable. The buffers produced by the supplier will each have their own independent life-cycle, and closing them will make them inaccessible, just like normally allocated buffers. The buffers produced are "constants", in the sense that they are read-only. It can generally be expected, but is not guaranteed, that the returned supplier is more resource efficient than allocating and copying memory with other available APIs. In such optimised implementations, the underlying memory baking the buffers will be shared among all the buffers produced by the supplier. The primary use case for this API, is when you need to repeatedly produce buffers with the same contents, and you perhaps wish to keep a `static final` field with these contents. The supplier-based API enforces that each usage get their own distinct buffer instance. Each of these instances cannot interfere with each other, so bugs like closing, or modifying the contents, of a shared buffer cannot occur. Parameters bytes:byte[] The byte contents of the buffers produced by the returned supplier. Returns:Supplier<Buffer> A supplier of read-only buffers with the given contents. Annotations @Override

public Supplier<Buffer> constBufferSupplier(byte[] bytes)

Implements io.netty5.buffer.BufferAllocator.constBufferSupplier.

Doc from io.netty5.buffer.BufferAllocator.constBufferSupplier.

Create a supplier of "constant" Buffers from this allocator, that all have the given byte contents. The buffer has the same capacity as the byte array length, and its write offset is placed at the end, and its read offset is at the beginning, such that the entire buffer contents are readable.

The buffers produced by the supplier will each have their own independent life-cycle, and closing them will make them inaccessible, just like normally allocated buffers.

The buffers produced are "constants", in the sense that they are read-only.

It can generally be expected, but is not guaranteed, that the returned supplier is more resource efficient than allocating and copying memory with other available APIs. In such optimised implementations, the underlying memory baking the buffers will be shared among all the buffers produced by the supplier.

The primary use case for this API, is when you need to repeatedly produce buffers with the same contents, and you perhaps wish to keep a static final field with these contents. The supplier-based API enforces that each usage get their own distinct buffer instance. Each of these instances cannot interfere with each other, so bugs like closing, or modifying the contents, of a shared buffer cannot occur.

Parameters

bytes:byte[]: The byte contents of the buffers produced by the returned supplier.

Returns:Supplier<Buffer>

A supplier of read-only buffers with the given contents.

Annotations

@Override

copyOf back to summary

copyOf	back to summary
public Buffer copyOf(String str, Charset charset) Overrides default io.netty5.buffer.BufferAllocator.copyOf. Doc from io.netty5.buffer.BufferAllocator.copyOf. Allocate a `Buffer` with the same size and contents of the given `String`, when interpreted as a sequence of bytes with the given `Charset`. This may throw an `OutOfMemoryError` if there is not enough free memory available to allocate a `Buffer` of the requested size. The allocated buffer will use big endian byte order. Parameters str:String The `String` that determines the size and contents of the new buffer. charset:Charset The `Charset` that determines how to turn the string into a sequence of bytes. Returns:Buffer The newly allocated `Buffer`. Annotations @Override

public Buffer copyOf(String str, Charset charset)

Overrides default io.netty5.buffer.BufferAllocator.copyOf.

Doc from io.netty5.buffer.BufferAllocator.copyOf.

Allocate a Buffer with the same size and contents of the given String, when interpreted as a sequence of bytes with the given Charset. This may throw an OutOfMemoryError if there is not enough free memory available to allocate a Buffer of the requested size.

The allocated buffer will use big endian byte order.

Parameters

str:String: The String that determines the size and contents of the new buffer.
charset:Charset: The Charset that determines how to turn the string into a sequence of bytes.

Returns:Buffer

The newly allocated Buffer.

Annotations

@Override

getAllocationType back to summary

getAllocationType	back to summary
public AllocationType getAllocationType() Implements io.netty5.buffer.BufferAllocator.getAllocationType. Doc from io.netty5.buffer.BufferAllocator.getAllocationType. Get the `AllocationType` from this allocator. This would typically be one of the `StandardAllocationTypes`. Returns:AllocationType The type of allocations performed by this allocator. Annotations @Override

public AllocationType getAllocationType()

Implements io.netty5.buffer.BufferAllocator.getAllocationType.

Doc from io.netty5.buffer.BufferAllocator.getAllocationType.

Get the AllocationType from this allocator. This would typically be one of the StandardAllocationTypes.

Returns:AllocationType

The type of allocations performed by this allocator.

Annotations

@Override

getAllocator back to summary

getAllocator	back to summary
public BufferAllocator getAllocator() Implements io.netty5.buffer.AllocatorControl.getAllocator. Doc from io.netty5.buffer.AllocatorControl.getAllocator. Get the `BufferAllocator` instance that is the source of this allocator control. Returns:BufferAllocator The `BufferAllocator` controlled by this `AllocatorControl`. Annotations @Override

public BufferAllocator getAllocator()

Implements io.netty5.buffer.AllocatorControl.getAllocator.

Doc from io.netty5.buffer.AllocatorControl.getAllocator.

Get the BufferAllocator instance that is the source of this allocator control.

Returns:BufferAllocator

The BufferAllocator controlled by this AllocatorControl.

Annotations

@Override

isPooling back to summary

isPooling	back to summary
public boolean isPooling() Implements io.netty5.buffer.BufferAllocator.isPooling. Doc from io.netty5.buffer.BufferAllocator.isPooling. Determine if this allocator is pooling and reusing its allocated memory. Returns:boolean `true` if this allocator is pooling and reusing its memory, `false` otherwise. Annotations @Override

public boolean isPooling()

Implements io.netty5.buffer.BufferAllocator.isPooling.

Doc from io.netty5.buffer.BufferAllocator.isPooling.

Determine if this allocator is pooling and reusing its allocated memory.

Returns:boolean

true if this allocator is pooling and reusing its memory, false otherwise.

Annotations

@Override

pack-priv Class ManagedBufferAllocator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail