kcenon::logger::memory::object_pool< T > Class Template Reference

Thread-safe object pool for high-performance memory management. More...

#include <object_pool.h>

Collaboration diagram for kcenon::logger::memory::object_pool< T >:

Classes
struct	config
	Configuration for object pool. More...
struct	statistics
	Get current pool statistics. More...

Public Member Functions
	object_pool (const config &cfg=config{})
	Construct object pool with configuration.
	~object_pool ()=default
	Destructor.
std::unique_ptr< T >	acquire ()
	Get an object from the pool.
void	release (std::unique_ptr< T > obj)
	Return an object to the pool.
statistics	get_statistics () const
	Get pool statistics.
void	clear ()
	Clear all objects from pool.

Private Member Functions
void	initialize_pool ()
	Initialize pool with initial objects.

Private Attributes
config	config_
	Pool configuration.
std::mutex	mutex_
	Thread safety mutex.
std::queue< std::unique_ptr< T > >	available_objects_
	Available objects.
std::atomic< size_t >	pool_size_
	Current pool size.

Detailed Description

template<typename T>
class kcenon::logger::memory::object_pool< T >

Thread-safe object pool for high-performance memory management.

Template Parameters

T	The type of objects to pool

Definition at line 29 of file object_pool.h.

Constructor & Destructor Documentation

object_pool()

template<typename T >

kcenon::logger::memory::object_pool< T >::object_pool ( const config & cfg = config{} )

inlineexplicit

Construct object pool with configuration.

Parameters

cfg	Pool configuration

Definition at line 46 of file object_pool.h.

                                                   {})
        : config_(cfg), pool_size_(0) {
        initialize_pool();
    }

~object_pool()

template<typename T >

kcenon::logger::memory::object_pool< T >::~object_pool ( )

default

Destructor.

Member Function Documentation

acquire()

template<typename T >

std::unique_ptr< T > kcenon::logger::memory::object_pool< T >::acquire ( )

inline

Get an object from the pool.

Returns

Unique pointer to object, or nullptr if pool is empty and growth is disabled

Definition at line 60 of file object_pool.h.

                               {
        std::lock_guard<std::mutex> lock(mutex_);
 
        if (!available_objects_.empty()) {
            auto obj = std::move(available_objects_.front());
            available_objects_.pop();
            return obj;
        }
 
        // If pool is empty and growth is allowed, create new object
        if (config_.allow_growth && pool_size_.load() < config_.max_size) {
            pool_size_.fetch_add(1);
            return std::make_unique<T>();
        }
 
        // Create temporary object if pool limits reached
        return std::make_unique<T>();
    }

References kcenon::logger::memory::object_pool< T >::config::allow_growth, kcenon::logger::memory::object_pool< T >::available_objects_, kcenon::logger::memory::object_pool< T >::config_, kcenon::logger::memory::object_pool< T >::config::max_size, kcenon::logger::memory::object_pool< T >::mutex_, and kcenon::logger::memory::object_pool< T >::pool_size_.

clear()

template<typename T >

void kcenon::logger::memory::object_pool< T >::clear ( )

inline

Clear all objects from pool.

Definition at line 122 of file object_pool.h.

                 {
        std::lock_guard<std::mutex> lock(mutex_);
        while (!available_objects_.empty()) {
            available_objects_.pop();
        }
        pool_size_.store(0);
    }

References kcenon::logger::memory::object_pool< T >::available_objects_, kcenon::logger::memory::object_pool< T >::mutex_, and kcenon::logger::memory::object_pool< T >::pool_size_.

get_statistics()

template<typename T >

statistics kcenon::logger::memory::object_pool< T >::get_statistics ( ) const

inline

Get pool statistics.

Returns

Current pool statistics

Definition at line 110 of file object_pool.h.

                                      {
        std::lock_guard<std::mutex> lock(mutex_);
        statistics stats;
        stats.total_size = pool_size_.load();
        stats.available_count = available_objects_.size();
        stats.in_use_count = pool_size_.load() - available_objects_.size();
        return stats;
    }

References kcenon::logger::memory::object_pool< T >::statistics::available_count, kcenon::logger::memory::object_pool< T >::available_objects_, kcenon::logger::memory::object_pool< T >::statistics::in_use_count, kcenon::logger::memory::object_pool< T >::mutex_, kcenon::logger::memory::object_pool< T >::pool_size_, and kcenon::logger::memory::object_pool< T >::statistics::total_size.

initialize_pool()

template<typename T >

void kcenon::logger::memory::object_pool< T >::initialize_pool ( )

inlineprivate

Initialize pool with initial objects.

Definition at line 134 of file object_pool.h.

                           {
        std::lock_guard<std::mutex> lock(mutex_);
 
        for (size_t i = 0; i < config_.initial_size; ++i) {
            available_objects_.push(std::make_unique<T>());
        }
 
        pool_size_.store(config_.initial_size);
    }

References kcenon::logger::memory::object_pool< T >::available_objects_, kcenon::logger::memory::object_pool< T >::config_, kcenon::logger::memory::object_pool< T >::config::initial_size, kcenon::logger::memory::object_pool< T >::mutex_, and kcenon::logger::memory::object_pool< T >::pool_size_.

release()

template<typename T >

void kcenon::logger::memory::object_pool< T >::release ( std::unique_ptr< T > obj )

inline

Return an object to the pool.

Parameters

obj	Object to return

Definition at line 83 of file object_pool.h.

                                       {
        if (!obj) {
            return;
        }
 
        std::lock_guard<std::mutex> lock(mutex_);
 
        // Only return to pool if not exceeding max size
        if (available_objects_.size() < config_.max_size) {
            available_objects_.push(std::move(obj));
        }
        // If exceeding max size, object will be destroyed automatically
    }

References kcenon::logger::memory::object_pool< T >::available_objects_, kcenon::logger::memory::object_pool< T >::config_, kcenon::logger::memory::object_pool< T >::config::max_size, and kcenon::logger::memory::object_pool< T >::mutex_.

Member Data Documentation

available_objects_

template<typename T >

std::queue<std::unique_ptr<T> > kcenon::logger::memory::object_pool< T >::available_objects_

private

Available objects.

Definition at line 146 of file object_pool.h.

Referenced by kcenon::logger::memory::object_pool< T >::acquire(), kcenon::logger::memory::object_pool< T >::clear(), kcenon::logger::memory::object_pool< T >::get_statistics(), kcenon::logger::memory::object_pool< T >::initialize_pool(), and kcenon::logger::memory::object_pool< T >::release().

config_

template<typename T >

config kcenon::logger::memory::object_pool< T >::config_

private

Pool configuration.

Definition at line 144 of file object_pool.h.

Referenced by kcenon::logger::memory::object_pool< T >::acquire(), kcenon::logger::memory::object_pool< T >::initialize_pool(), and kcenon::logger::memory::object_pool< T >::release().

mutex_

template<typename T >

std::mutex kcenon::logger::memory::object_pool< T >::mutex_

mutableprivate

Thread safety mutex.

Definition at line 145 of file object_pool.h.

Referenced by kcenon::logger::memory::object_pool< T >::acquire(), kcenon::logger::memory::object_pool< T >::clear(), kcenon::logger::memory::object_pool< T >::get_statistics(), kcenon::logger::memory::object_pool< T >::initialize_pool(), and kcenon::logger::memory::object_pool< T >::release().

pool_size_

template<typename T >

std::atomic<size_t> kcenon::logger::memory::object_pool< T >::pool_size_

private

Current pool size.

Definition at line 147 of file object_pool.h.

Referenced by kcenon::logger::memory::object_pool< T >::acquire(), kcenon::logger::memory::object_pool< T >::clear(), kcenon::logger::memory::object_pool< T >::get_statistics(), and kcenon::logger::memory::object_pool< T >::initialize_pool().

---

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

• src/impl/memory/object_pool.h