Package io.netty5.buffer.api

Incubating Buffer API, as a proposed alternative to ByteBuf.

Interface Summary

Interface	Description
AllocationType	An object used by buffer allocators to communicate desirable properties of an allocation to a memory manager, such as whether an allocation should be off-heap.
AllocatorControl	Methods for accessing and controlling the internals of an allocator.
Buffer	A life cycled buffer of memory, with separate reader and writer offsets.
BufferAccessor	This interface is just the primitive data accessor methods that Buffer exposes.
BufferAllocator	Interface for allocating Buffers.
ByteCursor	The ByteCursor scans through a sequence of bytes.
CompositeBuffer	The CompositeBuffer is a concrete Buffer implementation that make a number of other buffers appear as one.
Drop<T>	An interface used by Resource instances to implement their resource disposal mechanics.
LeakInfo	Information about a resource leak that happened.
LeakInfo.TracePoint	A moment in the life of the leaked object, for which some information was recorded.
MemoryManager	The choice of MemoryManager implementation also determines the choice of Buffer implementation.
Owned<T>	This interface encapsulates the ownership of a Resource, and exposes a method that may be used to transfer this ownership to the specified recipient thread.
ReadableComponent	A view onto the buffer component being processed in a given iteration of Buffer.forEachReadable(int, ReadableComponentProcessor).
ReadableComponentProcessor<E extends Exception>	A processor of readable components.
Resource<T extends Resource<T>>	A resource that has a life-time, and can be closed.
Send<T extends Resource<T>>	A temporary holder of a Resource, used for transferring the ownership of the resource from one thread to another.
WritableComponent	A view onto the buffer component being processed in a given iteration of Buffer.forEachWritable(int, WritableComponentProcessor).
WritableComponentProcessor<E extends Exception>	A processor of writable components.

Class Summary

Class	Description
BufferHolder<T extends BufferHolder<T>>	The BufferHolder is an abstract class that simplifies the implementation of objects that themselves contain a Buffer instance.
BufferRef	A mutable reference to a buffer.
BufferStub	A stub of a Buffer implementation that implements all buffer methods by delegating them to a wrapped buffer instance.
DefaultBufferAllocators	Accessor for the default, shared BufferAllocator instances.
LoggingLeakCallback	The LoggingLeakCallback can be installed to enable logging output when a leak is detected.

Enum Summary

Enum	Description
StandardAllocationTypes	Standard implementations of AllocationType that all memory managers should support.

Exception Summary

Exception	Description
BufferClosedException	An exception thrown when an operation is attempted on a Buffer when it has been closed.
BufferReadOnlyException	An exception thrown when an operation is attempted on a read-only Buffer.