UCommon
Protected Member Functions | Protected Attributes
ucommon::ReusableAllocator Class Reference

Class for resource bound memory pools between threads. More...

#include <thread.h>

Inheritance diagram for ucommon::ReusableAllocator:
Inheritance graph
[legend]
Collaboration diagram for ucommon::ReusableAllocator:
Collaboration graph
[legend]

Protected Member Functions

ReusableObjectnext (ReusableObject *object)
 Get next reusable object in the pool. More...
 
void release (ReusableObject *object)
 Release resuable object. More...
 
 ReusableAllocator ()
 Initialize reusable allocator through a conditional. More...
 
- Protected Member Functions inherited from ucommon::Conditional
void broadcast (void)
 Signal the conditional to release all waiting threads.
 
 Conditional ()
 Initialize and construct conditional.
 
void lock (void)
 Lock the conditional's supporting mutex.
 
void signal (void)
 Signal the conditional to release one waiting thread.
 
void unlock (void)
 Unlock the conditional's supporting mutex.
 
bool wait (timeout_t timeout)
 Conditional wait for signal on millisecond timeout. More...
 
bool wait (struct timespec *timeout)
 Conditional wait for signal on timespec timeout. More...
 
void wait (void)
 Wait (block) until signalled.
 
 ~Conditional ()
 Destroy conditional, release any blocked threads.
 

Protected Attributes

ReusableObjectfreelist
 
unsigned waiting
 

Additional Inherited Members

- Static Protected Member Functions inherited from ucommon::Conditional
static pthread_condattr_t * initializer (void)
 Support function for getting conditional attributes for realtime scheduling. More...
 
static void set (struct timespec *hires, timeout_t timeout)
 Convert a millisecond timeout into use for high resolution conditional timers. More...
 

Detailed Description

Class for resource bound memory pools between threads.

This is used to support a memory pool allocation scheme where a pool of reusable objects may be allocated, and the pool renewed by releasing objects or back. When the pool is used up, a pool consuming thread then must wait for a resource to be freed by another consumer (or timeout). This class is not meant to be used directly, but rather to build the synchronizing control between consumers which might be forced to wait for a resource.

Author
David Sugar dyfet.nosp@m.@gnu.nosp@m.telep.nosp@m.hony.nosp@m..org

Definition at line 708 of file thread.h.

Constructor & Destructor Documentation

ucommon::ReusableAllocator::ReusableAllocator ( )
protected

Initialize reusable allocator through a conditional.

Zero free list.

Member Function Documentation

ReusableObject* ucommon::ReusableAllocator::next ( ReusableObject object)
inlineprotected

Get next reusable object in the pool.

Parameters
objectfrom list.
Returns
next object.

Definition at line 724 of file thread.h.

Here is the call graph for this function:

void ucommon::ReusableAllocator::release ( ReusableObject object)
protected

Release resuable object.

Parameters
objectbeing released.

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