SharedMemMapping Class Reference

#include <sharedmemmapping.h>

Inheritance diagram for SharedMemMapping:

[legend]Collaboration diagram for SharedMemMapping:

[legend]List of all members.

Public Member Functions
	SharedMemMapping (const char *filename, side_t side)
virtual	~SharedMemMapping ()
key_t	openKeyChannel (key_t key)
key_t	getKey ()
bool	open ()
void	close ()

---

Constructor & Destructor Documentation

SharedMemMapping::SharedMemMapping (  const char *  filename, side_t  side )

Construct a new SharedMemMapping from a mapping file for the specified side. Parameters: filename  The path to the YML mapping file. side  Which side we are on SOURCE_SIDE or DEST_SIDE.

SharedMemMapping::~SharedMemMapping (   )  [virtual]

---

Member Function Documentation

key_t SharedMemMapping::openKeyChannel (  key_t  key  )

Open the key channel. If side is SOURCE_SIDE then ignore key and create a new key channel. The key channel key will be choosen at random. If side is DEST_SIDE the key will be used to attempt to open an existing channel. Parameters: key  The system identifier for the key channel. Returns: The key channel key on success, 0 otherwise.

key_t SharedMemMapping::getKey (   )  [inline]

Get the key channel key. The key channel key is the system id associated with the key exchanging shared memory. Returns: the key channel key.

bool SharedMemMapping::open (   )  [virtual]

Open the shared memory mapping. If the key channel has not yet been opened this function will automaticly fail. Returns: true on success, false otherwise. Reimplemented from Mapping.

void SharedMemMapping::close (   )  [virtual]

Close both the key channel and the mapping. Reimplemented from Mapping.

---

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

• sharedmemmapping.h
• sharedmemmapping.cpp

---