fm.liveswitch.IDataBufferPool Interface Reference

A data buffer pool interface. More...

Public Member Functions

abstract long getPooledBytesAvailable ()
 Gets the total bytes available in the pool. More...
 
abstract void releasePools ()
 Release the pools. More...
 
abstract fm.liveswitch.DataBuffer take (int size)
 Takes a buffer from the pool. More...
 
abstract fm.liveswitch.DataBuffer take (int size, boolean littleEndian)
 Takes a buffer from the pool. More...
 
abstract fm.liveswitch.DataBuffer take (int size, boolean littleEndian, boolean clearBytes)
 Takes a buffer from the pool. More...
 

Detailed Description

A data buffer pool interface.

Member Function Documentation

◆ getPooledBytesAvailable()

abstract long fm.liveswitch.IDataBufferPool.getPooledBytesAvailable ( )
abstract

Gets the total bytes available in the pool.

Implemented in fm.liveswitch.DataBufferPoolTracer, and fm.liveswitch.DataBufferPool.

◆ releasePools()

abstract void fm.liveswitch.IDataBufferPool.releasePools ( )
abstract

Release the pools.

Implemented in fm.liveswitch.DataBufferPoolTracer, and fm.liveswitch.DataBufferPool.

◆ take() [1/3]

abstract fm.liveswitch.DataBuffer fm.liveswitch.IDataBufferPool.take ( int  size)
abstract

Takes a buffer from the pool.

Parameters
sizeThe number of bytes needed.

Implemented in fm.liveswitch.DataBufferPoolTracer, and fm.liveswitch.DataBufferPool.

◆ take() [2/3]

abstract fm.liveswitch.DataBuffer fm.liveswitch.IDataBufferPool.take ( int  size,
boolean  littleEndian 
)
abstract

Takes a buffer from the pool.

Parameters
sizeThe number of bytes needed.
littleEndianWhether the data buffer should be little-endian.

Implemented in fm.liveswitch.DataBufferPoolTracer, and fm.liveswitch.DataBufferPool.

◆ take() [3/3]

abstract fm.liveswitch.DataBuffer fm.liveswitch.IDataBufferPool.take ( int  size,
boolean  littleEndian,
boolean  clearBytes 
)
abstract

Takes a buffer from the pool.

Parameters
sizeThe number of bytes needed.
littleEndianWhether the data buffer should be little-endian.
clearBytesWhether to clear the data buffer.

Implemented in fm.liveswitch.DataBufferPoolTracer, and fm.liveswitch.DataBufferPool.