pcpp::internal::DynamicObjectPool< T, > Class Template Reference

A generic object pool implementation. More...

#include <ObjectPool.h>

Public Member Functions
	DynamicObjectPool (std::size_t maxPoolSize=DEFAULT_POOL_SIZE, std::size_t initialSize=0)
	~DynamicObjectPool ()
	A destructor for this class that deletes all objects in the pool.
std::unique_ptr< T >	acquireObject ()
	Acquires a unique pointer to an object from the pool. More...
T *	acquireObjectRaw ()
	Acquires a raw pointer to an object from the pool. More...
void	releaseObject (std::unique_ptr< T > obj)
	Releases a unique pointer to an object back to the pool. More...
void	releaseObjectRaw (T *obj)
	Releases a raw pointer to an object back to the pool. More...
std::size_t	size () const
	Gets the current number of objects in the pool.
std::size_t	maxSize () const
	Gets the maximum number of objects in the pool.
void	setMaxSize (std::size_t maxSize)
	Sets the maximum number of objects in the pool.
void	preallocate (std::size_t count)
	Pre-allocates up to a minimum number of objects in the pool. More...
void	clear ()
	Deallocates and releases all objects currently held by the pool.

Detailed Description

template<class T, std::enable_if_t< std::is_default_constructible< T >::value, bool > = true>
class pcpp::internal::DynamicObjectPool< T, >

A generic object pool implementation.

This class provides a generic object pool that can be used to efficiently manage and reuse objects of any type. Objects can be acquired from the pool using the acquireObject method, and released back to the pool using the releaseObject method. If the pool is empty when acquiring an object, a new object will be created. If the pool is full when releasing an object, the object will be deleted.

Template Parameters

T	The type of objects managed by the pool. Must be default constructable.

Constructor & Destructor Documentation

DynamicObjectPool()

template<class T , std::enable_if_t< std::is_default_constructible< T >::value, bool > = true>

pcpp::internal::DynamicObjectPool< T, >::DynamicObjectPool ( std::size_t  maxPoolSize = DEFAULT_POOL_SIZE, std::size_t  initialSize = 0  )

inlineexplicit

A constructor for this class that creates a pool of objects

Parameters

[in]	maxPoolSize	The maximum number of objects in the pool
[in]	initialSize	The number of objects to preallocate in the pool

Member Function Documentation

acquireObject()

template<class T , std::enable_if_t< std::is_default_constructible< T >::value, bool > = true>

std::unique_ptr<T> pcpp::internal::DynamicObjectPool< T, >::acquireObject ( )

inline

Acquires a unique pointer to an object from the pool.

This method acquires a unique pointer to an object from the pool. If the pool is empty, a new object will be created.

Returns

A unique pointer to an object from the pool.

acquireObjectRaw()

template<class T , std::enable_if_t< std::is_default_constructible< T >::value, bool > = true>

T* pcpp::internal::DynamicObjectPool< T, >::acquireObjectRaw ( )

inline

Acquires a raw pointer to an object from the pool.

This method acquires a raw pointer to an object from the pool. If the pool is empty, a new object will be created.

Returns

A raw pointer to an object from the pool.

preallocate()

template<class T , std::enable_if_t< std::is_default_constructible< T >::value, bool > = true>

void pcpp::internal::DynamicObjectPool< T, >::preallocate ( std::size_t  count )

inline

Pre-allocates up to a minimum number of objects in the pool.

Parameters

count

The number of objects to pre-allocate.

releaseObject()

template<class T , std::enable_if_t< std::is_default_constructible< T >::value, bool > = true>

void pcpp::internal::DynamicObjectPool< T, >::releaseObject ( std::unique_ptr< T >  obj )

inline

Releases a unique pointer to an object back to the pool.

This method releases a unique pointer to an object back to the pool. If the pool is full, the object will be deleted.

Parameters

[in]

obj

The unique pointer to the object to release.

releaseObjectRaw()

template<class T , std::enable_if_t< std::is_default_constructible< T >::value, bool > = true>

void pcpp::internal::DynamicObjectPool< T, >::releaseObjectRaw ( T *  obj )

inline

Releases a raw pointer to an object back to the pool.

This method releases a raw pointer to an object back to the pool. If the pool is full, the object will be deleted.

Parameters

[in]

obj

The raw pointer to the object to release.