CrystalSpace

Public API Reference

CS::Threading::OptionalMutex< _Lock > Class Template Reference

Helper that is a (non-recursive) mutex if _Lock is true or does nothing if _Lock is false. More...

#include <csutil/threading/mutex.h>

List of all members.

Public Member Functions

bool Lock ()
bool TryLock ()
void Unlock ()

Detailed Description

template<bool _Lock>
class CS::Threading::OptionalMutex< _Lock >

Helper that is a (non-recursive) mutex if _Lock is true or does nothing if _Lock is false.

Intended to provide compile-time switching of locking behaviour.

Definition at line 125 of file mutex.h.


Member Function Documentation

template<bool _Lock>
bool CS::Threading::OptionalMutex< _Lock >::Lock (  )  [inline]
See also:
Mutex::Lock

Definition at line 130 of file mutex.h.

template<bool _Lock>
bool CS::Threading::OptionalMutex< _Lock >::TryLock (  )  [inline]
See also:
Mutex::TryLock

Definition at line 132 of file mutex.h.

template<bool _Lock>
void CS::Threading::OptionalMutex< _Lock >::Unlock (  )  [inline]
See also:
Mutex::Unlock

Definition at line 134 of file mutex.h.


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

Generated for Crystal Space 1.4.1 by doxygen 1.7.1