Netty 5.0.0.Alpha5 · io.netty5.channel.ReadBufferAllocator

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public Buffer	Returns: the `Buffer` that will be used or `null` if the read should not happen until the next `ChannelOutboundInvoker#read(ReadBufferAllocator)` call is done. allocate(BufferAllocator The `BufferAllocator` that might be used for the allocation. While its fine to not use the `BufferAllocator` it is important that the returned `Buffer` matches the `BufferAllocator#getAllocationType()` of the allocator. allocator, int the estimated capacity for the buffer. This is just a best guess and users might decide to use their own capacity. estimatedCapacity) Allocates a `Buffer` that is used for the next actual read to store the data in.
public static ReadBufferAllocator	Returns: a `ReadBufferAllocator`. exact(int the number of bytes that can be written. numBytes) Return a `ReadBufferAllocator` that will return a `Buffer` that has exact `numBytes` of writable bytes.

Returns:

the Buffer that will be used or null if the read should not happen until the next ChannelOutboundInvoker#read(ReadBufferAllocator) call is done.

allocate(BufferAllocator

The BufferAllocator that might be used for the allocation. While its fine to not use the BufferAllocator it is important that the returned Buffer matches the BufferAllocator#getAllocationType() of the allocator.

allocator, int

the estimated capacity for the buffer. This is just a best guess and users might decide to use their own capacity.

estimatedCapacity)

Allocates a Buffer that is used for the next actual read to store the data in.

public static ReadBufferAllocator

Returns:

a ReadBufferAllocator.

exact(int

the number of bytes that can be written.

numBytes)

Return a ReadBufferAllocator that will return a Buffer that has exact numBytes of writable bytes.

Method Detail

allocate back to summary

allocate	back to summary
public Buffer allocate(BufferAllocator allocator, int estimatedCapacity) Allocates a `Buffer` that is used for the next actual read to store the data in. Parameters allocator:BufferAllocator The `BufferAllocator` that might be used for the allocation. While its fine to not use the `BufferAllocator` it is important that the returned `Buffer` matches the `BufferAllocator#getAllocationType()` of the allocator. estimatedCapacity:int the estimated capacity for the buffer. This is just a best guess and users might decide to use their own capacity. Returns:Buffer the `Buffer` that will be used or `null` if the read should not happen until the next `ChannelOutboundInvoker#read(ReadBufferAllocator)` call is done.

public Buffer allocate(BufferAllocator allocator, int estimatedCapacity)

Allocates a Buffer that is used for the next actual read to store the data in.

Parameters

allocator:BufferAllocator: The BufferAllocator that might be used for the allocation. While its fine to not use the BufferAllocator it is important that the returned Buffer matches the BufferAllocator#getAllocationType() of the allocator.
estimatedCapacity:int: the estimated capacity for the buffer. This is just a best guess and users might decide to use their own capacity.

Returns:Buffer

the Buffer that will be used or null if the read should not happen until the next ChannelOutboundInvoker#read(ReadBufferAllocator) call is done.

exact back to summary

exact	back to summary
public static ReadBufferAllocator exact(int numBytes) Return a `ReadBufferAllocator` that will return a `Buffer` that has exact `numBytes` of writable bytes. Parameters numBytes:int the number of bytes that can be written. Returns:ReadBufferAllocator a `ReadBufferAllocator`.

public static ReadBufferAllocator exact(int numBytes)

Return a ReadBufferAllocator that will return a Buffer that has exact numBytes of writable bytes.

Parameters

numBytes:int: the number of bytes that can be written.

Returns:ReadBufferAllocator

a ReadBufferAllocator.

public Interface ReadBufferAllocator

Method Summary

Method Detail