Fixed-size dynamically-allocated byte buffer. More...

#include <buffer.h>

Inheritance diagram for roc::core::Buffer:

Public Member Functions
	Buffer (IPool &buffer_pool, size_t buffer_size)
	Initialize empty buffer.
size_t	size () const
	Get buffer size in bytes.
uint8_t *	data ()
	Get buffer data.
Public Member Functions inherited from roc::core::RefCounted< Buffer, PoolAllocation >
	RefCounted ()
	Initialize.
int	getref () const
	Get reference counter.
void	incref () const
	Increment reference counter.
void	decref () const
	Decrement reference counter.

Static Public Member Functions
static Buffer *	container_of (void *data)
	Get pointer to buffer from the pointer to its data.

Additional Inherited Members
Protected Member Functions inherited from roc::core::PoolAllocation
IPool &	pool () const
	Get pool.
	PoolAllocation (IPool &pool)
	Initialize.
template<class T>
void	destroy (T &object)
	Destroy object and return memory to pool.

Detailed Description

Fixed-size dynamically-allocated byte buffer.

Remarks: Buffer size is fixed, but determined at runtime, not compile time. It is defined by the pool that allocates the buffer. User typically works with buffers via Slice, which holds a shared pointer to buffer and points to a variable-size subset of its memory.

Definition at line 40 of file buffer.h.

Constructor & Destructor Documentation

roc::core::Buffer::Buffer	(	IPool &	buffer_pool,
		size_t	buffer_size )

Initialize empty buffer.

Buffer * roc::core::Buffer::container_of ( void * data )

inlinestatic

Get pointer to buffer from the pointer to its data.

Definition at line 56 of file buffer.h.

uint8_t * roc::core::Buffer::data ( )

inline

Get buffer data.

Definition at line 51 of file buffer.h.

size_t roc::core::Buffer::size ( ) const

inline

Get buffer size in bytes.

Definition at line 46 of file buffer.h.

The documentation for this class was generated from the following file: