Interface IBufferPool

An interface used to acquire/release recyclable chunks of bytes to be reused without need to triggering GC.

Namespace: Akka.IO.Buffers
Assembly: Akka.dll
Syntax
public interface IBufferPool

Methods

| Edit this page View Source

Diagnostics()

Declaration
BufferPoolInfo Diagnostics()
Returns
Type Description
BufferPoolInfo
| Edit this page View Source

Release(ArraySegment<byte>)

Releases a single byte buffer for further use.

Declaration
void Release(ArraySegment<byte> buf)
Parameters
Type Name Description
ArraySegment<byte> buf
| Edit this page View Source

Release(IEnumerable<ArraySegment<byte>>)

Releases a collection of previously allocated byte buffers for further use.

Declaration
void Release(IEnumerable<ArraySegment<byte>> buf)
Parameters
Type Name Description
IEnumerable<ArraySegment<byte>> buf
| Edit this page View Source

Rent()

Rents a byte buffer representing a single continuous block of memory. Size of byte buffer is dependent from the implementation. Once rent, byte buffers are expected to be released using Release(ArraySegment<byte>) method.

Declaration
ArraySegment<byte> Rent()
Returns
Type Description
ArraySegment<byte>
| Edit this page View Source

Rent(int)

Rents a sequence of byte buffers representing (potentially non-continuous) range of memory that is big enough to fit the minimumSize requested. Once rent, byte buffers are expected to be released using Release(ArraySegment<byte>) method.

Declaration
IEnumerable<ArraySegment<byte>> Rent(int minimumSize)
Parameters
Type Name Description
int minimumSize

Minimum size in bytes, that returned collection of byte buffers must be able to fit.
Returns
Type Description
IEnumerable<ArraySegment<byte>>

Extension Methods