qx::unique_objects_pool< T > Class Template Reference

Class stores unique objects and allows access to them through tokens. More...

#include <unique_objects_pool.h>

Classes
class	token
	The token is used for distributed access to a unique object in the pool. More...

Public Member Functions
	unique_objects_pool (bool bAutoCleanup=true) noexcept
	unique_objects_pool object constructor More...
template<class U >
token	get_or_create (U &&value) noexcept
	Get or create object. More...
void	shrink ()
	Remove unused (with counter = 0) objects.
size_t	size () const
	Get number of objects stored. More...
bool	empty () const
	Is pool empty. More...

Detailed Description

template<class T>
class qx::unique_objects_pool< T >

Class stores unique objects and allows access to them through tokens.

Class is thread safe

Template Parameters

T	- object type

Author

Khrapov

Date

11.02.2023

Definition at line 42 of file unique_objects_pool.h.

Constructor & Destructor Documentation

unique_objects_pool()

template<class T >

qx::unique_objects_pool< T >::unique_objects_pool ( bool  bAutoCleanup = true )

inlinenoexcept

unique_objects_pool object constructor

Parameters

bAutoCleanup

- if true, objects will be deleted when usages count reaches 0, otherwise you should use shrink()

Definition at line 91 of file unique_objects_pool.inl.

Member Function Documentation

empty()

template<class T >

bool qx::unique_objects_pool< T >::empty

inline

Is pool empty.

Return values

-	true if pool is empty

Definition at line 162 of file unique_objects_pool.inl.

get_or_create()

template<class T >

template<class U >

unique_objects_pool< T >::token qx::unique_objects_pool< T >::get_or_create ( U &&  value )

inlinenoexcept

Get or create object.

Template Parameters

U	- value type

Parameters

value

- object to search and to construct if wasn't able to find

Return values

-	token to existing or constructed object

Definition at line 97 of file unique_objects_pool.inl.

size()

template<class T >

size_t qx::unique_objects_pool< T >::size

inline

Get number of objects stored.

Return values

-	number of objects stored

Definition at line 153 of file unique_objects_pool.inl.

---

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

• include/qx/containers/unique_objects_pool.h
• include/qx/containers/unique_objects_pool.inl