Updated FastMutex documentation.

This commit is contained in:
martin-osborne
2014-11-01 09:38:56 +00:00
parent 569102c18c
commit 1e1822f6c6

View File

@@ -96,10 +96,11 @@ private:
class Foundation_API FastMutex: private FastMutexImpl class Foundation_API FastMutex: private FastMutexImpl
/// A FastMutex (mutual exclusion) is similar to a Mutex. /// A FastMutex (mutual exclusion) is similar to a Mutex.
/// Unlike a Mutex, however, a FastMutex is not recursive, /// Locking a FastMutex is guaranteed to be at least as
/// which means that a deadlock will occur if the same /// fast as locking a Mutex. However, a FastMutex is not
/// thread tries to lock a mutex it has already locked again. /// guaranteed to be either recursive or non-recursive.
/// Locking a FastMutex is faster than locking a recursive Mutex. /// It is best suited to thread safe components like pools,
/// caches and queues where locking is internal to the component.
/// Using the ScopedLock class is the preferred way to automatically /// Using the ScopedLock class is the preferred way to automatically
/// lock and unlock a mutex. /// lock and unlock a mutex.
{ {