dispenso::ResourcePool< T > Class Template Reference

#include <resource_pool.h>

Public Member Functions
template<typename F >
	ResourcePool (size_t size, const F &init)
Resource< T >	acquire ()
	~ResourcePool ()

Friends
class	Resource< T >

Detailed Description

template<typename T>
class dispenso::ResourcePool< T >

A pool of resources that can be accessed from multiple threads. This is akin to a set of resources and a semaphore ensuring enough resources exist.

Examples

resource_pool_example.cpp.

Definition at line 77 of file resource_pool.h.

Constructor & Destructor Documentation

ResourcePool()

template<typename T >

template<typename F >

dispenso::ResourcePool< T >::ResourcePool ( size_t size, const F & init )

inline

Construct a ResourcePool.

Parameters

size	The number of T objects in the pool.
init	A functor with signature T() which can be called to initialize the pool's resources.

Definition at line 87 of file resource_pool.h.

~ResourcePool()

template<typename T >

dispenso::ResourcePool< T >::~ResourcePool ( )

inline

Destruct the ResourcePool. The user must ensure that all resources are returned to the pool prior to destroying the pool.

Definition at line 125 of file resource_pool.h.

Member Function Documentation

acquire()

template<typename T >

Resource< T > dispenso::ResourcePool< T >::acquire ( )

inline

Acquire a resource from the pool. This function may block until a resource becomes available.

Returns

a Resource-wrapped resource.

Definition at line 113 of file resource_pool.h.

Friends And Related Symbol Documentation

Resource< T >

template<typename T >

friend class Resource< T >

friend

Definition at line 146 of file resource_pool.h.

---

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

• /github/workspace/dispenso/resource_pool.h