Share::Mutex Class Reference
[Internal library classes]

Platform-independent mutex representation. More...

#include <MutexLock.h>

List of all members.

Public Member Functions

 Mutex (RelocPtr< char > name) throw (ShareException)
 Create mutex.
 ~Mutex () throw ()
 Destroy mutex.
void lock (LockData *data) throw (ShareException)
 Lock mutex.
void unlock (LockData *data) throw (ShareException)
 Unlock mutex.

Classes

struct  LockData
 Mutex per-lock specific data. More...


Detailed Description

Platform-independent mutex representation.

Note:
Implementation of this class was taken from MSDTk.

Definition at line 40 of file MutexLock.h.


Constructor & Destructor Documentation

Share::Mutex::Mutex ( RelocPtr< char >  name  )  throw (ShareException)

Create mutex.

Parameters:
name Name of mutex to create.
Note:
Parameter name is not used on Linux for now.
Exceptions:
ShareException Library-specific exception derived from std::bad_alloc

Share::Mutex::~Mutex (  )  throw ()

Destroy mutex.


Member Function Documentation

void Share::Mutex::lock ( LockData data  )  throw (ShareException)

Lock mutex.

Process will be susspended if mutex is already locked.

Parameters:
data Pointer to structure containing per-lock specific data.
Exceptions:
ShareException Library-specific exception derived from std::bad_alloc

void Share::Mutex::unlock ( LockData data  )  throw (ShareException)

Unlock mutex.

Parameters:
data Pointer to structure containing per-lock specific data.
Exceptions:
ShareException Library-specific exception derived from std::bad_alloc


The documentation for this class was generated from the following file:
Generated on Sun Aug 26 17:43:02 2007 for ShareLibrary by  doxygen 1.5.2