Module io.netty5.buffer
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 thatBufferexposes.BufferAllocator Interface for allocatingBuffers.ByteCursor The ByteCursor scans through a sequence of bytes.ComponentIterator<T extends ComponentIterator.Next> A facade for iterating the readable or writable components of aBuffer.ComponentIterator.Next This interface exposes external iteration on components.CompositeBuffer TheCompositeBufferis a concreteBufferimplementation that make a number of other buffers appear as one.Drop<T> An interface used byResourceinstances 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 ofMemoryManagerimplementation also determines the choice ofBufferimplementation.Owned<T> This interface encapsulates the ownership of aResource, 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 ofBuffer.forEachReadable(int, ReadableComponentProcessor).ReadableComponentProcessor<E extends Exception> A processor of readable components.WritableComponent A view onto the buffer component being processed in a given iteration ofBuffer.forEachWritable(int, WritableComponentProcessor).WritableComponentProcessor<E extends Exception> A processor of writable components. -
Class Summary Class Description BufferHolder<T extends Resource<T>> TheBufferHolderis an abstract class that simplifies the implementation of objects that themselves contain aBufferinstance.BufferRef A mutable reference to a buffer.BufferStub A stub of aBufferimplementation that implements all buffer methods by delegating them to a wrapped buffer instance.DefaultBufferAllocators Accessor for the default, sharedBufferAllocatorinstances.LoggingLeakCallback TheLoggingLeakCallbackcan be installed to enable logging output when a leak is detected.SensitiveBufferAllocator ThisBufferAllocatoris for allocating off-heapBuffers that may contain sensitive information, which should be erased from memory (overwritten) when the buffer is closed. -
Enum Summary Enum Description StandardAllocationTypes Standard implementations ofAllocationTypethat all memory managers should support. -
Exception Summary Exception Description BufferClosedException An exception thrown when an operation is attempted on aBufferwhen it has been closed.BufferReadOnlyException