roc::core::IPool Class Reference

Memory pool interface. More...

#include <ipool.h>

Inheritance diagram for roc::core::IPool:

Public Member Functions
virtual size_t	allocation_size () const =0
	Get size of the allocation per object. Covers all internal overhead, if any. More...
virtual size_t	object_size () const =0
	Get size of the object (without overhead). More...
virtual ROC_ATTR_NODISCARD bool	reserve (size_t n_objects)=0
	Reserve memory for given number of objects. More...
virtual void *	allocate ()=0
	Allocate memory for an object. More...
virtual void	deallocate (void *memory)=0
	Return memory to pool. More...
template<class T >
void	destroy_object (T &object)
	Destroy object and deallocate its memory. More...

Detailed Description

Memory pool interface.

Definition at line 23 of file ipool.h.

Member Function Documentation

allocate()

virtual void* roc::core::IPool::allocate ( )

pure virtual

Allocate memory for an object.

Returns

pointer to a maximum aligned uninitialized memory for a new object or NULL if memory can't be allocated.

Implemented in roc::core::SlabPool< T, EmbeddedCapacity >, roc::core::SlabPool< Stream, PreallocatedStreams >, roc::core::SlabPool< SourceNode, PreallocatedSources >, roc::core::SlabPool< roc::core::Buffer >, roc::core::SlabPool< Route, PreallocatedRoutes >, roc::core::SlabPool< roc::packet::Packet >, roc::core::SlabPool< Address, PreallocatedAddresses >, roc::core::SlabPool< Slot >, roc::core::SlabPool< Node, PreallocatedNodes >, and roc::core::LimitedPool.

allocation_size()

virtual size_t roc::core::IPool::allocation_size ( ) const

pure virtual

Get size of the allocation per object. Covers all internal overhead, if any.

Implemented in roc::core::SlabPool< T, EmbeddedCapacity >, roc::core::SlabPool< Stream, PreallocatedStreams >, roc::core::SlabPool< SourceNode, PreallocatedSources >, roc::core::SlabPool< roc::core::Buffer >, roc::core::SlabPool< Route, PreallocatedRoutes >, roc::core::SlabPool< roc::packet::Packet >, roc::core::SlabPool< Address, PreallocatedAddresses >, roc::core::SlabPool< Slot >, roc::core::SlabPool< Node, PreallocatedNodes >, and roc::core::LimitedPool.

deallocate()

virtual void roc::core::IPool::deallocate ( void *  memory )

pure virtual

Return memory to pool.

Implemented in roc::core::SlabPool< T, EmbeddedCapacity >, roc::core::SlabPool< Stream, PreallocatedStreams >, roc::core::SlabPool< SourceNode, PreallocatedSources >, roc::core::SlabPool< roc::core::Buffer >, roc::core::SlabPool< Route, PreallocatedRoutes >, roc::core::SlabPool< roc::packet::Packet >, roc::core::SlabPool< Address, PreallocatedAddresses >, roc::core::SlabPool< Slot >, roc::core::SlabPool< Node, PreallocatedNodes >, and roc::core::LimitedPool.

destroy_object()

template<class T >

void roc::core::IPool::destroy_object ( T &  object )

inline

Destroy object and deallocate its memory.

Definition at line 49 of file ipool.h.

object_size()

virtual size_t roc::core::IPool::object_size ( ) const

pure virtual

Get size of the object (without overhead).

Implemented in roc::core::SlabPool< T, EmbeddedCapacity >, roc::core::SlabPool< Stream, PreallocatedStreams >, roc::core::SlabPool< SourceNode, PreallocatedSources >, roc::core::SlabPool< roc::core::Buffer >, roc::core::SlabPool< Route, PreallocatedRoutes >, roc::core::SlabPool< roc::packet::Packet >, roc::core::SlabPool< Address, PreallocatedAddresses >, roc::core::SlabPool< Slot >, roc::core::SlabPool< Node, PreallocatedNodes >, and roc::core::LimitedPool.

reserve()

virtual ROC_ATTR_NODISCARD bool roc::core::IPool::reserve ( size_t  n_objects )

pure virtual

Reserve memory for given number of objects.

Returns

false if allocation failed.

Implemented in roc::core::SlabPool< T, EmbeddedCapacity >, roc::core::SlabPool< Stream, PreallocatedStreams >, roc::core::SlabPool< SourceNode, PreallocatedSources >, roc::core::SlabPool< roc::core::Buffer >, roc::core::SlabPool< Route, PreallocatedRoutes >, roc::core::SlabPool< roc::packet::Packet >, roc::core::SlabPool< Address, PreallocatedAddresses >, roc::core::SlabPool< Slot >, roc::core::SlabPool< Node, PreallocatedNodes >, and roc::core::LimitedPool.

---

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

• roc_core/ipool.h