Template class to map typed vector into shared memory.
More...
#include <mapped.h>
Public Member Functions |
void * | addLock (void) |
| Add mapped space while holding lock for one object.
|
unsigned | getSize (void) |
| Get member size of typed objects that can be held in mapped vector.
|
void | initialize (void) |
| Initialize typed data in mapped array.
|
| mapped_array (const char *name, unsigned number) |
| Construct mapped vector array of typed objects.
|
T * | operator() (unsigned member) |
| Get typed pointer to member object of vector in mapped segment.
|
T * | operator() (void) |
| Allocate mapped space for one object.
|
T & | operator[] (unsigned member) |
| Reference typed object of vector in mapped segment.
|
Protected Member Functions |
void | create (const char *fn, unsigned members) |
Detailed Description
Template class to map typed vector into shared memory.
This is used to construct a typed read/write vector of objects that are held in a named shared memory segment.
- Author:
- David Sugar <dyfet@gnutelephony.org>
Constructor & Destructor Documentation
ucommon::mapped_array::mapped_array |
( |
const char * |
name, |
|
|
unsigned |
number |
|
) |
| [inline] |
Construct mapped vector array of typed objects.
This is constructed for read/write access. mapped_view is used in all cases for read-only access to mapped data. Member objects are linearly allocated from the shared memory segment, or may simply be directly accessed by offset.
- Parameters:
-
name | of mapped segment to construct. |
number | of objects in the mapped vector. |
Definition at line 288 of file mapped.h.
Member Function Documentation
void* ucommon::mapped_array::addLock |
( |
void |
| ) |
[inline] |
Add mapped space while holding lock for one object.
- Returns:
- address of object.
Definition at line 302 of file mapped.h.
unsigned ucommon::mapped_array::getSize |
( |
void |
| ) |
[inline] |
Get member size of typed objects that can be held in mapped vector.
- Returns:
- members mapped in segment.
Definition at line 332 of file mapped.h.
void ucommon::mapped_array::initialize |
( |
void |
| ) |
[inline] |
Initialize typed data in mapped array.
Assumes default constructor for type.
Definition at line 295 of file mapped.h.
T* ucommon::mapped_array::operator() |
( |
unsigned |
member | ) |
[inline] |
Get typed pointer to member object of vector in mapped segment.
- Parameters:
-
- Returns:
- typed pointer or NULL if past end of array.
Definition at line 310 of file mapped.h.
T* ucommon::mapped_array::operator() |
( |
void |
| ) |
[inline] |
Allocate mapped space for one object.
- Returns:
- address of object.
Definition at line 317 of file mapped.h.
T& ucommon::mapped_array::operator[] |
( |
unsigned |
member | ) |
[inline] |
Reference typed object of vector in mapped segment.
- Parameters:
-
- Returns:
- typed reference.
Definition at line 325 of file mapped.h.
The documentation for this class was generated from the following file: