Uses of Interface
io.netty5.buffer.api.BufferAllocator

Packages that use BufferAllocator

Package	Description
io.netty5.buffer	Abstraction of a byte buffer - the fundamental data structure to represent a low-level binary and text message.
io.netty5.buffer.api	Incubating Buffer API, as a proposed alternative to ByteBuf.
io.netty5.buffer.api.pool	A pooling BufferAllocator implementation based on jemalloc.
io.netty5.channel	The core channel API which is asynchronous and event-driven abstraction of various transports such as a NIO Channel.
io.netty5.channel.epoll	Optimized transport for linux which uses EPOLL Edge-Triggered Mode for maximal performance.
io.netty5.channel.internal	Internal utilities for channel implementations.
io.netty5.channel.unix	Unix specific transport.
io.netty5.handler.codec	Extensible decoder and its common implementations which deal with the packet fragmentation and reassembly issue found in a stream-based transport such as TCP/IP.
io.netty5.handler.codec.base64	Encoder and decoder which transform a Base64-encoded String or io.netty5.buffer.ByteBuf into a decoded io.netty5.buffer.ByteBuf and vice versa.
io.netty5.handler.codec.compression	Encoder and decoder which compresses and decompresses io.netty5.buffer.ByteBufs in a compression format such as zlib, gzip, and Snappy.
io.netty5.handler.codec.dns	DNS codec.
io.netty5.handler.codec.http	Encoder, decoder and their related message types for HTTP.
io.netty5.handler.codec.http.websocketx	Encoder, decoder, handshakers and their related message types for Web Socket data frames.
io.netty5.handler.codec.http2	Handlers for sending and receiving HTTP/2 frames.
io.netty5.handler.ssl	SSL · TLS implementation based on SSLEngine
io.netty5.handler.stream	Writes very large data stream asynchronously neither spending a lot of memory nor getting OutOfMemoryError.

Uses of BufferAllocator in io.netty5.buffer

Methods in io.netty5.buffer with parameters of type BufferAllocator

Modifier and Type	Method	Description
static Buffer	BufferUtil.writeAscii(BufferAllocator alloc, CharSequence seq)	Encode a CharSequence in ASCII and write it to a Buffer allocated with alloc.

Uses of BufferAllocator in io.netty5.buffer.api

Classes in io.netty5.buffer.api that implement BufferAllocator

Modifier and Type	Class	Description
class	SensitiveBufferAllocator	This BufferAllocator is for allocating off-heap Buffers that may contain sensitive information, which should be erased from memory (overwritten) when the buffer is closed.

Methods in io.netty5.buffer.api that return BufferAllocator

Modifier and Type	Method	Description
BufferAllocator	AllocatorControl.getAllocator()	Get the BufferAllocator instance that is the source of this allocator control.
static BufferAllocator	DefaultBufferAllocators.offHeapAllocator()	Get the shared off-heap allocator.
static BufferAllocator	BufferAllocator.offHeapPooled()	Produces a pooling BufferAllocator that allocates and recycles off-heap buffers.
static BufferAllocator	BufferAllocator.offHeapUnpooled()	Produces a BufferAllocator that allocates unpooled, off-heap buffers.
static BufferAllocator	DefaultBufferAllocators.onHeapAllocator()	Get the shared on-heap allocator.
static BufferAllocator	BufferAllocator.onHeapPooled()	Produces a pooling BufferAllocator that allocates and recycles on-heap buffers.
static BufferAllocator	BufferAllocator.onHeapUnpooled()	Produces a BufferAllocator that allocates unpooled, on-heap buffers.
static BufferAllocator	DefaultBufferAllocators.preferredAllocator()	Get the preferred, shared allocator.
static BufferAllocator	SensitiveBufferAllocator.sensitiveOffHeapAllocator()	Get the sensitive off-heap buffer allocator instance.

Methods in io.netty5.buffer.api with parameters of type BufferAllocator

Modifier and Type	Method	Description
static CompositeBuffer	CompositeBuffer.compose(BufferAllocator allocator)	Create an empty composite buffer, that has no components.

Uses of BufferAllocator in io.netty5.buffer.api.pool

Classes in io.netty5.buffer.api.pool that implement BufferAllocator

Modifier and Type	Class	Description
class	PooledBufferAllocator

Uses of BufferAllocator in io.netty5.channel

Fields in io.netty5.channel with type parameters of type BufferAllocator

Modifier and Type	Field	Description
static ChannelOption<BufferAllocator>	ChannelOption.BUFFER_ALLOCATOR

Methods in io.netty5.channel that return BufferAllocator

Modifier and Type	Method	Description
BufferAllocator	AbstractChannel.bufferAllocator()
BufferAllocator	Channel.bufferAllocator()	Return the assigned BufferAllocator which will be used to allocate Buffers.
default BufferAllocator	ChannelHandlerContext.bufferAllocator()	Return the assigned BufferAllocator which will be used to allocate Buffers.

Methods in io.netty5.channel with parameters of type BufferAllocator

Modifier and Type	Method	Description
Buffer	DefaultMaxMessagesRecvBufferAllocator.MaxMessageHandle.allocate(BufferAllocator alloc)
Buffer	RecvBufferAllocator.Handle.allocate(BufferAllocator alloc)	Creates a new receive buffer whose capacity is probably large enough to read all inbound data and small enough not to waste its space.
protected abstract Buffer	AbstractCoalescingBufferQueue.compose(BufferAllocator alloc, Buffer cumulation, Buffer next)	Calculate the result of current + next.
protected Buffer	CoalescingBufferQueue.compose(BufferAllocator alloc, Buffer cumulation, Buffer next)
protected Buffer	AbstractCoalescingBufferQueue.composeFirst(BufferAllocator allocator, Buffer first)	Calculate the first Buffer which will be used in subsequent calls to AbstractCoalescingBufferQueue.compose(BufferAllocator, Buffer, Buffer).
protected Buffer	AbstractCoalescingBufferQueue.composeIntoComposite(BufferAllocator alloc, Buffer cumulation, Buffer next)	Compose cumulation and next into a new CompositeBuffer.
protected Buffer	AbstractCoalescingBufferQueue.copyAndCompose(BufferAllocator alloc, Buffer cumulation, Buffer next, int minIncrement)	Compose cumulation and next into a new Buffer suitable for IO.
Buffer	AbstractCoalescingBufferQueue.remove(BufferAllocator alloc, int bytes, Promise<Void> aggregatePromise)	Remove a Buffer from the queue with the specified number of bytes.
void	AbstractChannel.setBufferAllocator(BufferAllocator bufferAllocator)

Uses of BufferAllocator in io.netty5.channel.epoll

Methods in io.netty5.channel.epoll with parameters of type BufferAllocator

Modifier and Type	Method	Description
protected void	EpollDatagramChannel.epollInReady(RecvBufferAllocator.Handle handle, BufferAllocator recvBufferAllocator, boolean receivedRdHup)
protected void	EpollServerSocketChannel.epollInReady(RecvBufferAllocator.Handle allocHandle, BufferAllocator recvBufferAllocator, boolean receivedRdHup)
protected void	EpollSocketChannel.epollInReady(RecvBufferAllocator.Handle handle, BufferAllocator recvBufferAllocator, boolean receivedRdHup)

Uses of BufferAllocator in io.netty5.channel.internal

Methods in io.netty5.channel.internal that return BufferAllocator

Modifier and Type	Method	Description
BufferAllocator	DelegatingChannelHandlerContext.bufferAllocator()

Uses of BufferAllocator in io.netty5.channel.unix

Methods in io.netty5.channel.unix that return BufferAllocator

Modifier and Type	Method	Description
protected abstract BufferAllocator	SocketWritableByteChannel.alloc()

Uses of BufferAllocator in io.netty5.handler.codec

Methods in io.netty5.handler.codec with parameters of type BufferAllocator

Modifier and Type	Method	Description
protected abstract void	MessageAggregator.aggregate(BufferAllocator allocator, A aggregated, C content)	Aggregated the passed content in the passed aggregate.
protected abstract A	MessageAggregator.beginAggregation(BufferAllocator allocator, S start)	Creates a new aggregated message from the specified start message.
Buffer	ByteToMessageDecoder.Cumulator.cumulate(BufferAllocator alloc, Buffer cumulation, Buffer in)	Cumulate the given Buffers and return the Buffer that holds the cumulated bytes.
protected void	MessageAggregator.finishAggregation(BufferAllocator allocator, A aggregated)	Invoked when the specified aggregated message is about to be passed to the next handler in the pipeline.

Constructors in io.netty5.handler.codec with parameters of type BufferAllocator

Constructor	Description
ByteToMessageCodec(BufferAllocator allocator)	Create a new instance which will try to detect the types to match out of the type parameter of the class.
ByteToMessageCodec(Class<? extends I> outboundMessageType, BufferAllocator allocator)	Create a new instance

Uses of BufferAllocator in io.netty5.handler.codec.base64

Methods in io.netty5.handler.codec.base64 with parameters of type BufferAllocator

Modifier and Type	Method	Description
static Buffer	Base64.decode(Buffer src, int off, int len, Base64Dialect dialect, BufferAllocator allocator)
static Buffer	Base64.encode(Buffer src, int off, int len, boolean breakLines, Base64Dialect dialect, BufferAllocator allocator)

Uses of BufferAllocator in io.netty5.handler.codec.compression

Methods in io.netty5.handler.codec.compression with parameters of type BufferAllocator

Modifier and Type	Method	Description
Buffer	BrotliCompressor.compress(Buffer input, BufferAllocator allocator)
Buffer	Bzip2Compressor.compress(Buffer in, BufferAllocator allocator)
Buffer	Compressor.compress(Buffer input, BufferAllocator allocator)	This method will read from the input Buffer and compress into a new Buffer that will be allocated (if needed) from the BufferAllocator.
Buffer	FastLzCompressor.compress(Buffer in, BufferAllocator allocator)
Buffer	Lz4Compressor.compress(Buffer input, BufferAllocator allocator)
Buffer	LzfCompressor.compress(Buffer in, BufferAllocator allocator)
Buffer	LzmaCompressor.compress(Buffer in, BufferAllocator allocator)
Buffer	SnappyCompressor.compress(Buffer in, BufferAllocator allocator)
Buffer	ZlibCompressor.compress(Buffer uncompressed, BufferAllocator allocator)
Buffer	ZstdCompressor.compress(Buffer in, BufferAllocator allocator)
Buffer	BrotliDecompressor.decompress(Buffer input, BufferAllocator allocator)
Buffer	Bzip2Decompressor.decompress(Buffer in, BufferAllocator allocator)
Buffer	Decompressor.decompress(Buffer input, BufferAllocator allocator)	This method will read from the input Buffer and decompress into a new Buffer that will be allocated (if needed) from the BufferAllocator.
Buffer	FastLzDecompressor.decompress(Buffer in, BufferAllocator allocator)
Buffer	Lz4Decompressor.decompress(Buffer in, BufferAllocator allocator)
Buffer	LzfDecompressor.decompress(Buffer in, BufferAllocator allocator)
Buffer	SnappyDecompressor.decompress(Buffer in, BufferAllocator allocator)
Buffer	ZlibDecompressor.decompress(Buffer in, BufferAllocator allocator)
Buffer	BrotliCompressor.finish(BufferAllocator allocator)
Buffer	Bzip2Compressor.finish(BufferAllocator allocator)
Buffer	Compressor.finish(BufferAllocator allocator)	By calling this method we signal that the compression stream is marked as finish.
Buffer	FastLzCompressor.finish(BufferAllocator allocator)
Buffer	Lz4Compressor.finish(BufferAllocator allocator)
Buffer	LzfCompressor.finish(BufferAllocator allocator)
Buffer	LzmaCompressor.finish(BufferAllocator allocator)
Buffer	SnappyCompressor.finish(BufferAllocator allocator)
Buffer	ZlibCompressor.finish(BufferAllocator allocator)
Buffer	ZstdCompressor.finish(BufferAllocator allocator)
protected Buffer	ZlibDecompressor.prepareDecompressBuffer(BufferAllocator allocator, Buffer buffer, int preferredSize)	Allocate or expand the decompression buffer, without exceeding the maximum allocation.

Uses of BufferAllocator in io.netty5.handler.codec.dns

Methods in io.netty5.handler.codec.dns with parameters of type BufferAllocator

Modifier and Type	Method	Description
<T extends DnsRecord> T	DefaultDnsRecordDecoder.decodeRecord(BufferAllocator allocator, Buffer in)
protected DnsRecord	DefaultDnsRecordDecoder.decodeRecord(String name, DnsRecordType type, int dnsClass, long timeToLive, BufferAllocator allocator, Buffer in, int offset, int length)	Decodes a record from the information decoded so far by DnsRecordDecoder.decodeRecord(BufferAllocator, Buffer).
<T extends DnsRecord> T	DnsRecordDecoder.decodeRecord(BufferAllocator allocator, Buffer in)	Decodes a DNS record into its object representation.

Uses of BufferAllocator in io.netty5.handler.codec.http

Methods in io.netty5.handler.codec.http with parameters of type BufferAllocator

Modifier and Type	Method	Description
protected HttpResponse	HttpServerExpectContinueHandler.acceptMessage(BufferAllocator allocator, HttpRequest request)	Produces a HttpResponse for HttpRequests which define an expectation.
protected void	HttpObjectAggregator.aggregate(BufferAllocator allocator, FullHttpMessage<?> aggregated, HttpContent<C> content)
protected FullHttpMessage<?>	HttpObjectAggregator.beginAggregation(BufferAllocator allocator, HttpMessage start)
protected Buffer	HttpObjectEncoder.crlfBuffer(BufferAllocator allocator)
protected void	HttpObjectAggregator.finishAggregation(BufferAllocator allocator, FullHttpMessage<?> aggregated)
HttpContent<?>	HttpChunkedInput.readChunk(BufferAllocator allocator)
protected HttpResponse	HttpServerExpectContinueHandler.rejectResponse(BufferAllocator allocator, HttpRequest request)	Returns the appropriate 4XX HttpResponse for the given HttpRequest.
protected Buffer	HttpObjectEncoder.zeroCrlfCrlfBuffer(BufferAllocator allocator)

Constructors in io.netty5.handler.codec.http with parameters of type BufferAllocator

Constructor	Description
EmptyLastHttpContent(BufferAllocator allocator)

Uses of BufferAllocator in io.netty5.handler.codec.http.websocketx

Methods in io.netty5.handler.codec.http.websocketx with parameters of type BufferAllocator

Modifier and Type	Method	Description
protected void	WebSocketFrameAggregator.aggregate(BufferAllocator allocator, WebSocketFrame aggregated, ContinuationWebSocketFrame content)
protected WebSocketFrame	WebSocketFrameAggregator.beginAggregation(BufferAllocator allocator, WebSocketFrame start)
protected abstract FullHttpRequest	WebSocketClientHandshaker.newHandshakeRequest(BufferAllocator allocator)	Returns a new {@link FullHttpRequest) which will be used for the handshake.
protected FullHttpRequest	WebSocketClientHandshaker13.newHandshakeRequest(BufferAllocator allocator)	/**
protected abstract FullHttpResponse	WebSocketServerHandshaker.newHandshakeResponse(BufferAllocator allocator, FullHttpRequest req, HttpHeaders responseHeaders)	Returns a new {@link FullHttpResponse) which will be used for as response to the handshake request.
protected FullHttpResponse	WebSocketServerHandshaker13.newHandshakeResponse(BufferAllocator allocator, FullHttpRequest req, HttpHeaders headers)	Handle the web socket handshake for the web socket specification HyBi versions 13-17.
WebSocketFrame	WebSocketChunkedInput.readChunk(BufferAllocator allocator)	Fetches a chunked data from the stream.

Constructors in io.netty5.handler.codec.http.websocketx with parameters of type BufferAllocator

Constructor	Description
CloseWebSocketFrame(BufferAllocator allocator, boolean finalFragment, int rsv)	Creates a new close frame with no losing status code and no reason text
CloseWebSocketFrame(BufferAllocator allocator, boolean finalFragment, int rsv, int statusCode, String reasonText)	Creates a new close frame with closing status code and reason text
CloseWebSocketFrame(BufferAllocator allocator, int statusCode, String reasonText)	Creates a new empty close frame with closing status code and reason text
CloseWebSocketFrame(BufferAllocator allocator, WebSocketCloseStatus status)	Creates a new empty close frame with closing status code and reason text
CloseWebSocketFrame(BufferAllocator allocator, WebSocketCloseStatus status, String reasonText)	Creates a new empty close frame with closing status code and reason text
ContinuationWebSocketFrame(BufferAllocator allocator, boolean finalFragment, int rsv, String text)	Creates a new continuation frame with the specified text data
TextWebSocketFrame(BufferAllocator allocator, boolean finalFragment, int rsv, String text)	Creates a new text frame with the specified text string.
TextWebSocketFrame(BufferAllocator allocator, String text)	Creates a new text frame with the specified text string.

Uses of BufferAllocator in io.netty5.handler.codec.http2

Methods in io.netty5.handler.codec.http2 with parameters of type BufferAllocator

Modifier and Type	Method	Description
protected FullHttpMessage<?>	InboundHttp2ToHttpAdapter.newMessage(Http2Stream stream, Http2Headers headers, boolean validateHttpHeaders, BufferAllocator alloc)	Create a new FullHttpMessage based upon the current connection parameters
Http2DataFrame	Http2DataChunkedInput.readChunk(BufferAllocator allocator)
static FullHttpRequest	HttpConversionUtil.toFullHttpRequest(int streamId, Http2Headers http2Headers, BufferAllocator alloc, boolean validateHttpHeaders)	Create a new object to contain the request data
static FullHttpRequest	HttpConversionUtil.toFullHttpRequest(int streamId, Http2Headers http2Headers, Buffer content, boolean validateHttpHeaders, BufferAllocator allocator)	Create a new object to contain the request data
static FullHttpResponse	HttpConversionUtil.toFullHttpResponse(int streamId, Http2Headers http2Headers, BufferAllocator alloc, boolean validateHttpHeaders)	Create a new object to contain the response data

Uses of BufferAllocator in io.netty5.handler.ssl

Methods in io.netty5.handler.ssl with parameters of type BufferAllocator

Modifier and Type	Method	Description
SSLEngine	DelegatingSslContext.newEngine(BufferAllocator alloc)
SSLEngine	DelegatingSslContext.newEngine(BufferAllocator alloc, String peerHost, int peerPort)
SSLEngine	JdkSslContext.newEngine(BufferAllocator alloc)
SSLEngine	JdkSslContext.newEngine(BufferAllocator alloc, String peerHost, int peerPort)
SSLEngine	ReferenceCountedOpenSslContext.newEngine(BufferAllocator alloc)	Returns a new server-side SSLEngine with the current configuration.
SSLEngine	ReferenceCountedOpenSslContext.newEngine(BufferAllocator alloc, String peerHost, int peerPort)
abstract SSLEngine	SslContext.newEngine(BufferAllocator alloc)	Creates a new SSLEngine.
abstract SSLEngine	SslContext.newEngine(BufferAllocator alloc, String peerHost, int peerPort)	Creates a new SSLEngine using advisory peer information.
protected SslHandler	DelegatingSslContext.newHandler(BufferAllocator alloc, boolean startTls)
protected SslHandler	DelegatingSslContext.newHandler(BufferAllocator alloc, boolean startTls, Executor executor)
protected SslHandler	DelegatingSslContext.newHandler(BufferAllocator alloc, String peerHost, int peerPort, boolean startTls)
protected SslHandler	DelegatingSslContext.newHandler(BufferAllocator alloc, String peerHost, int peerPort, boolean startTls, Executor executor)
protected SslHandler	ReferenceCountedOpenSslContext.newHandler(BufferAllocator alloc, boolean startTls)
protected SslHandler	ReferenceCountedOpenSslContext.newHandler(BufferAllocator alloc, boolean startTls, Executor executor)
protected SslHandler	ReferenceCountedOpenSslContext.newHandler(BufferAllocator alloc, String peerHost, int peerPort, boolean startTls)
protected SslHandler	ReferenceCountedOpenSslContext.newHandler(BufferAllocator alloc, String peerHost, int peerPort, boolean startTls, Executor executor)
SslHandler	SslContext.newHandler(BufferAllocator alloc)	Create a new SslHandler.
protected SslHandler	SslContext.newHandler(BufferAllocator alloc, boolean startTls)	Create a new SslHandler.
protected SslHandler	SslContext.newHandler(BufferAllocator alloc, boolean startTls, Executor executor)	Create a new SslHandler.
SslHandler	SslContext.newHandler(BufferAllocator alloc, String peerHost, int peerPort)	Creates a new SslHandler
protected SslHandler	SslContext.newHandler(BufferAllocator alloc, String peerHost, int peerPort, boolean startTls)	Create a new SslHandler.
protected SslHandler	SslContext.newHandler(BufferAllocator alloc, String peerHost, int peerPort, boolean startTls, Executor delegatedTaskExecutor)
SslHandler	SslContext.newHandler(BufferAllocator alloc, String peerHost, int peerPort, Executor delegatedTaskExecutor)	Creates a new SslHandler with advisory peer information.
SslHandler	SslContext.newHandler(BufferAllocator alloc, Executor delegatedTaskExecutor)	Creates a new SslHandler.
protected SslHandler	SniHandler.newSslHandler(SslContext context, BufferAllocator allocator)	Returns a new SslHandler using the given SslContext and BufferAllocator.

Uses of BufferAllocator in io.netty5.handler.stream

Methods in io.netty5.handler.stream with parameters of type BufferAllocator

Modifier and Type	Method	Description
Buffer	ChunkedFile.readChunk(BufferAllocator allocator)
B	ChunkedInput.readChunk(BufferAllocator allocator)	Fetches a chunked data from the stream.
Buffer	ChunkedNioFile.readChunk(BufferAllocator allocator)
Buffer	ChunkedNioStream.readChunk(BufferAllocator allocator)
Buffer	ChunkedStream.readChunk(BufferAllocator allocator)