Flair
Framework Libre Air
flair::core::SharedMem Class Reference

Class defining a shared memory. More...

#include <SharedMem.h>

+ Inheritance diagram for flair::core::SharedMem:

Public Member Functions

 SharedMem (const Object *parent, std::string name, size_t size)
 Constructor. More...
 
 ~SharedMem ()
 Destructor. More...
 
void Write (const char *buf, size_t size)
 Write. More...
 
void Read (char *buf, size_t size) const
 Read. More...
 
- Public Member Functions inherited from flair::core::Object
 Object (const Object *parent=NULL, std::string name="", std::string type="")
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
std::string ObjectName (void) const
 Name. More...
 
std::string ObjectType (void) const
 Type. More...
 
const ObjectParent (void) const
 Parent. More...
 
std::vector< const Object * > * TypeChilds (void) const
 Childs of the same type. More...
 
std::vector< const Object * > * Childs (void) const
 Childs. More...
 
void Information (const char *function, int line, const char *format,...) const
 Formatted information. More...
 
void Warning (const char *function, const char *format,...) const
 Formatted warning. More...
 
void Error (const char *function, const char *format,...) const
 Formatted error. More...
 
bool ErrorOccured (bool recursive=true) const
 Has an errror occured? More...
 

Additional Inherited Members

- Public Types inherited from flair::core::Object
enum  color_t { Auto = 0, Red = 31, Green = 32, Orange = 33 }
 

Detailed Description

Class defining a shared memory.

Shared memory is identified by its name so it can be accessed by another processus using its name.

Constructor & Destructor Documentation

flair::core::SharedMem::SharedMem ( const Object parent,
std::string  name,
size_t  size 
)

Constructor.

Construct a shared memory object

Parameters
parentparent
namename
sizesize of the shared memory
flair::core::SharedMem::~SharedMem ( )

Destructor.

Member Function Documentation

void flair::core::SharedMem::Write ( const char *  buf,
size_t  size 
)

Write.

Parameters
bufinput buffer to write to memory
sizebuffer size
void flair::core::SharedMem::Read ( char *  buf,
size_t  size 
) const

Read.

Parameters
bufoutput buffer to write from memory
sizebuffer size