kcenon::pacs::core::tracked_pool< T > Class Template Reference

Pool wrapper with statistics tracking. More...

#include <pool_manager.h>

Inheritance diagram for kcenon::pacs::core::tracked_pool< T >:

Collaboration diagram for kcenon::pacs::core::tracked_pool< T >:

Public Types
using	pool_type = kcenon::common::utils::ObjectPool<T>
using	unique_ptr_type = std::unique_ptr<T, std::function<void(T*)>>

Public Member Functions
	tracked_pool (std::size_t initial_size=32)
template<typename... Args>
auto	acquire (Args &&... args) -> unique_ptr_type
	Acquire an object from the pool.
auto	statistics () const noexcept -> const pool_statistics &
	Get the pool statistics.
auto	available () const -> std::size_t
	Get the number of available objects in the pool.
void	reserve (std::size_t count)
	Reserve additional capacity in the pool.
void	clear ()
	Clear the pool and release all memory.

Private Attributes
pool_type	pool_
pool_statistics	stats_

Detailed Description

template<typename T>
class kcenon::pacs::core::tracked_pool< T >

Pool wrapper with statistics tracking.

Template Parameters

T	The type of objects to pool

Definition at line 72 of file pool_manager.h.

Member Typedef Documentation

pool_type

template<typename T >

using kcenon::pacs::core::tracked_pool< T >::pool_type = kcenon::common::utils::ObjectPool<T>

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/core/pool_manager.h.

Definition at line 74 of file pool_manager.h.

unique_ptr_type

template<typename T >

using kcenon::pacs::core::tracked_pool< T >::unique_ptr_type = std::unique_ptr<T, std::function<void(T*)>>

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/core/pool_manager.h.

Definition at line 75 of file pool_manager.h.

Constructor & Destructor Documentation

tracked_pool()

template<typename T >

kcenon::pacs::core::tracked_pool< T >::tracked_pool ( std::size_t initial_size = 32 )

inlineexplicit

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/core/pool_manager.h.

Definition at line 77 of file pool_manager.h.

        : pool_(initial_size) {
        pool_.reserve(initial_size);
    }

References kcenon::pacs::core::tracked_pool< T >::pool_.

Member Function Documentation

acquire()

template<typename T >

template<typename... Args>

auto kcenon::pacs::core::tracked_pool< T >::acquire ( Args &&... args ) -> unique_ptr_type

inline

Acquire an object from the pool.

Parameters

args	Arguments forwarded to the object's constructor

Returns

A unique_ptr that returns the object to the pool on destruction

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/core/pool_manager.h.

Definition at line 88 of file pool_manager.h.

                                                    {
        bool reused = false;
        auto ptr = pool_.acquire(&reused, std::forward<Args>(args)...);
 
        stats_.total_acquisitions.fetch_add(1, std::memory_order_relaxed);
        if (reused) {
            stats_.pool_hits.fetch_add(1, std::memory_order_relaxed);
        } else {
            stats_.pool_misses.fetch_add(1, std::memory_order_relaxed);
        }
 
        return ptr;
    }

References kcenon::pacs::core::tracked_pool< T >::pool_, kcenon::pacs::core::pool_statistics::pool_hits, kcenon::pacs::core::pool_statistics::pool_misses, kcenon::pacs::core::tracked_pool< T >::stats_, and kcenon::pacs::core::pool_statistics::total_acquisitions.

available()

template<typename T >

auto kcenon::pacs::core::tracked_pool< T >::available ( ) const -> std::size_t

inlinenodiscard

Get the number of available objects in the pool.

Returns

Available object count

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/core/pool_manager.h.

Definition at line 114 of file pool_manager.h.

                                                      {
        return pool_.available();
    }

References kcenon::pacs::core::tracked_pool< T >::pool_.

clear()

template<typename T >

void kcenon::pacs::core::tracked_pool< T >::clear ( )

inline

Clear the pool and release all memory.

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/core/pool_manager.h.

Definition at line 129 of file pool_manager.h.

                 {
        pool_.clear();
    }

References kcenon::pacs::core::tracked_pool< T >::pool_.

reserve()

template<typename T >

void kcenon::pacs::core::tracked_pool< T >::reserve ( std::size_t count )

inline

Reserve additional capacity in the pool.

Parameters

count

Number of objects to pre-allocate

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/core/pool_manager.h.

Definition at line 122 of file pool_manager.h.

                                  {
        pool_.reserve(count);
    }

References kcenon::pacs::core::tracked_pool< T >::pool_.

statistics()

template<typename T >

auto kcenon::pacs::core::tracked_pool< T >::statistics ( ) const -> const pool_statistics&

inlinenodiscardnoexcept

Get the pool statistics.

Returns

Reference to the statistics

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/core/pool_manager.h.

Definition at line 106 of file pool_manager.h.

                                                                             {
        return stats_;
    }

References kcenon::pacs::core::tracked_pool< T >::stats_.

Member Data Documentation

pool_

template<typename T >

pool_type kcenon::pacs::core::tracked_pool< T >::pool_

private

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/core/pool_manager.h.

Definition at line 134 of file pool_manager.h.

Referenced by kcenon::pacs::core::tracked_pool< T >::acquire(), kcenon::pacs::core::tracked_pool< T >::available(), kcenon::pacs::core::tracked_pool< T >::clear(), kcenon::pacs::core::tracked_pool< T >::reserve(), and kcenon::pacs::core::tracked_pool< T >::tracked_pool().

stats_

template<typename T >

pool_statistics kcenon::pacs::core::tracked_pool< T >::stats_

private

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/core/pool_manager.h.

Definition at line 135 of file pool_manager.h.

Referenced by kcenon::pacs::core::tracked_pool< T >::acquire(), and kcenon::pacs::core::tracked_pool< T >::statistics().

---

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

• include/kcenon/pacs/core/pool_manager.h