From 1e1822f6c62a7644d72e0a772aa9889865487fb0 Mon Sep 17 00:00:00 2001 From: martin-osborne Date: Sat, 1 Nov 2014 09:38:56 +0000 Subject: [PATCH] Updated FastMutex documentation. --- Foundation/include/Poco/Mutex.h | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/Foundation/include/Poco/Mutex.h b/Foundation/include/Poco/Mutex.h index 40c9dc0ac..c4f849e7d 100644 --- a/Foundation/include/Poco/Mutex.h +++ b/Foundation/include/Poco/Mutex.h @@ -96,10 +96,11 @@ private: class Foundation_API FastMutex: private FastMutexImpl /// A FastMutex (mutual exclusion) is similar to a Mutex. - /// Unlike a Mutex, however, a FastMutex is not recursive, - /// which means that a deadlock will occur if the same - /// thread tries to lock a mutex it has already locked again. - /// Locking a FastMutex is faster than locking a recursive Mutex. + /// Locking a FastMutex is guaranteed to be at least as + /// fast as locking a Mutex. However, a FastMutex is not + /// guaranteed to be either recursive or non-recursive. + /// 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 /// lock and unlock a mutex. {