An array of reusable types. More...
#include <vector.h>
Inheritance diagram for ucommon::array_reuse< T >:
Collaboration diagram for ucommon::array_reuse< T >:
Public Member Functions | |
| array_reuse (unsigned count) | |
| Create private heap of reusable objects of specified type. | |
| T * | create (void) |
| Create a typed object from the heap. | |
| T * | create (timeout_t timeout) |
| Create a typed object from the heap. | |
| T * | get (void) |
| Get a typed object from the heap. | |
| T * | get (timeout_t timeout) |
| Get a typed object from the heap. | |
| operator bool () | |
| Test if typed objects available in heap or re-use list. | |
| operator T * () | |
| Get a typed object from the heap by type casting reference. | |
| bool | operator! () |
| Test if the entire heap has been allocated. | |
| T * | operator* () |
| Get a typed object from the heap by pointer reference. | |
| void | release (T *object) |
| Release (return) a typed object back to the heap for re-use. | |
| T * | request (void) |
| Request immediately next available typed object from the heap. | |
Detailed Description
template<class T>
class ucommon::array_reuse< T >
An array of reusable types.
A pool of typed objects is created which can be allocated as needed. Deallocated typed objects are returned to the pool so they can be reallocated later. This is a private fixed size heap.
Constructor & Destructor Documentation
template<class T >
| ucommon::array_reuse< T >::array_reuse | ( | unsigned | count | ) | [inline] |
Member Function Documentation
template<class T >
| T* ucommon::array_reuse< T >::create | ( | void | ) | [inline] |
template<class T >
| T* ucommon::array_reuse< T >::create | ( | timeout_t | timeout | ) | [inline] |
template<class T >
| T* ucommon::array_reuse< T >::get | ( | void | ) | [inline] |
Get a typed object from the heap.
This function blocks when the heap is empty until an object is returned to the heap.
- Returns:
- typed object pointer from heap.
Reimplemented from ucommon::ArrayReuse.
template<class T >
| T* ucommon::array_reuse< T >::get | ( | timeout_t | timeout | ) | [inline] |
Get a typed object from the heap.
This function blocks until the the heap has an object to return or the timer has expired.
- Parameters:
-
timeout to wait for heap in milliseconds.
- Returns:
- typed object pointer from heap or NULL if timeout.
Reimplemented from ucommon::ArrayReuse.
template<class T >
| ucommon::array_reuse< T >::operator bool | ( | ) | [inline] |
template<class T >
| ucommon::array_reuse< T >::operator T * | ( | ) | [inline] |
template<class T >
| bool ucommon::array_reuse< T >::operator! | ( | ) | [inline] |
template<class T >
| T* ucommon::array_reuse< T >::operator* | ( | ) | [inline] |
template<class T >
| void ucommon::array_reuse< T >::release | ( | T * | object | ) | [inline] |
template<class T >
| T* ucommon::array_reuse< T >::request | ( | void | ) | [inline] |
Request immediately next available typed object from the heap.
- Returns:
- typed object pointer or NULL if heap is empty.
Reimplemented from ucommon::ArrayReuse.
The documentation for this class was generated from the following file:
- ucommon/vector.h
