CLAM-Development  1.1
Classes | Public Types | Public Member Functions | Friends
CLAM::Mutex Class Reference

From the www.boost.org docs: A mutex (short for mutual-exclusion) object is used to serializes access to a resource shared between multiple threads. More...

#include <Mutex.hxx>

List of all members.

Classes

struct  ConditionVar

Public Types

typedef Hidden::ScopedLock< MutexScopedLock

Public Member Functions

 Mutex ()
 ~Mutex ()

Friends

class Hidden::LockOps< Mutex >
class Hidden::ScopedLock< Mutex >

Detailed Description

From the www.boost.org docs: A mutex (short for mutual-exclusion) object is used to serializes access to a resource shared between multiple threads.

The Mutex concept, with TryMutex and TimedMutex refinements, formalize the requirements. A model that implements Mutex and its refinements has two states: locked and unlocked. Before using a shared resource, a thread locks a Boost.Threads mutex object (an object whose type is a model of Mutex or one of it's refinements), insuring thread-safe access to the shared resource. When use of the shared resource is complete, the thread unlocks the mutex object, allowing another thread to acquire the lock and use the shared resource.

Definition at line 48 of file Mutex.hxx.


Member Typedef Documentation

Definition at line 55 of file Mutex.hxx.


Constructor & Destructor Documentation

Definition at line 30 of file Mutex.cxx.

References CLAM_ASSERT.

Definition at line 39 of file Mutex.cxx.

References CLAM_ASSERT.


Friends And Related Function Documentation

friend class Hidden::LockOps< Mutex > [friend]

Definition at line 52 of file Mutex.hxx.

friend class Hidden::ScopedLock< Mutex > [friend]

Definition at line 53 of file Mutex.hxx.


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