ucc::mapped_view< T > Class Template Reference

Class to access a named mapped segment published from another process. More...

#include <mapped.h>

Inheritance diagram for ucc::mapped_view< T >:

Inheritance graph
[legend]
Collaboration diagram for ucc::mapped_view< T >:

Collaboration graph
[legend]

Public Member Functions

void copy (unsigned member, T *buffer)
volatile T * get (unsigned member)
unsigned getCount (void)
 Get count of typed member objects held in this map.
 mapped_view (char *name)
 Map existing named memory segment.
volatile T * operator() (unsigned member)
 Access typed member object in the mapped segment.
volatile T & operator[] (unsigned member)
 Reference typed member object in the mapped segment.

Detailed Description

template<class T>
class ucc::mapped_view< T >

Class to access a named mapped segment published from another process.

This offers a simple typed vector interface to access the shared memory segment in read-only mode.

Author:
David Sugar <dyfet@gnutelephony.org>

Definition at line 463 of file mapped.h.


Constructor & Destructor Documentation

template<class T>
ucc::mapped_view< T >::mapped_view ( char *  name  )  [inline]

Map existing named memory segment.

The size of the map is derived from the existing map alone.

Parameters:
name of memory segment to map.

Definition at line 471 of file mapped.h.


Member Function Documentation

template<class T>
unsigned ucc::mapped_view< T >::getCount ( void   )  [inline]

Get count of typed member objects held in this map.

Returns:
count of typed member objects.

Definition at line 500 of file mapped.h.

template<class T>
volatile T* ucc::mapped_view< T >::operator() ( unsigned  member  )  [inline]

Access typed member object in the mapped segment.

Parameters:
member to access.
Returns:
typed object pointer.

Definition at line 479 of file mapped.h.

template<class T>
volatile T& ucc::mapped_view< T >::operator[] ( unsigned  member  )  [inline]

Reference typed member object in the mapped segment.

Parameters:
member to access.
Returns:
typed object reference.

Definition at line 487 of file mapped.h.


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

Generated on Tue May 17 12:15:33 2011 for UCommon by  doxygen 1.5.6