aboutsummaryrefslogtreecommitdiff
path: root/dep/include/zthread/FastRecursiveMutex.h
diff options
context:
space:
mode:
authormegamage <none@none>2009-02-12 17:09:15 -0600
committermegamage <none@none>2009-02-12 17:09:15 -0600
commit6aee5fcbe7473a3cbac12b7e8482a7b98bef8be3 (patch)
tree91ec91d5c19eba9c2fe0e84b1c9dc7047a3de80e /dep/include/zthread/FastRecursiveMutex.h
parent2d2f433b4de1c35b22aaf07854fc0ee11fcb350d (diff)
parentf385747164c3fb278c92ef46fbd6c3da6590bbf0 (diff)
*Merge.
--HG-- branch : trunk
Diffstat (limited to 'dep/include/zthread/FastRecursiveMutex.h')
-rw-r--r--dep/include/zthread/FastRecursiveMutex.h28
1 files changed, 14 insertions, 14 deletions
diff --git a/dep/include/zthread/FastRecursiveMutex.h b/dep/include/zthread/FastRecursiveMutex.h
index a30f4b53aa7..5a3322e3c65 100644
--- a/dep/include/zthread/FastRecursiveMutex.h
+++ b/dep/include/zthread/FastRecursiveMutex.h
@@ -39,10 +39,10 @@ namespace ZThread {
*
* A FastRecursiveMutex is a small fast implementation of a recursive, mutally exclusive
* Lockable object. This implementation is a bit faster than the other Mutex classes
- * as it involved the least overhead. However, this slight increase in speed is
- * gained by sacrificing the robustness provided by the other classes.
+ * as it involved the least overhead. However, this slight increase in speed is
+ * gained by sacrificing the robustness provided by the other classes.
*
- * A FastRecursiveMutex has the useful property of not being interruptable; that is to say
+ * A FastRecursiveMutex has the useful property of not being interruptable; that is to say
* that acquire() and tryAcquire() will not throw Interrupted_Exceptions.
*
* @see RecursiveMutex
@@ -54,13 +54,13 @@ namespace ZThread {
* <b>Error Checking</b>
*
* No error checking is performed, this means there is the potential for deadlock.
- */
+ */
class ZTHREAD_API FastRecursiveMutex : public Lockable, private NonCopyable {
-
+
FastRecursiveLock* _lock;
public:
-
+
//! Create a new FastRecursiveMutex
FastRecursiveMutex();
@@ -68,7 +68,7 @@ namespace ZThread {
virtual ~FastRecursiveMutex();
/**
- * Acquire exclusive access to the mutex. The calling thread will block until the
+ * Acquire exclusive access to the mutex. The calling thread will block until the
* lock can be acquired. No safety or state checks are performed. The calling thread
* may acquire the mutex nore than once.
*
@@ -76,21 +76,21 @@ namespace ZThread {
* @exception Interrupted_Exception never thrown
*/
virtual void acquire();
-
+
/**
* Release access. No safety or state checks are performed.
- *
+ *
* @pre the caller should have previously acquired this lock at least once.
*/
virtual void release();
-
+
/**
- * Try to acquire exclusive access to the mutex. The calling thread will block until the
+ * Try to acquire exclusive access to the mutex. The calling thread will block until the
* lock can be acquired. No safety or state checks are performed. The calling thread
* may acquire the mutex more than once.
*
* @param timeout unused
- * @return
+ * @return
* - <em>true</em> if the lock was acquired
* - <em>false</em> if the lock was acquired
*
@@ -98,8 +98,8 @@ namespace ZThread {
* @exception Interrupted_Exception never thrown
*/
virtual bool tryAcquire(unsigned long timeout);
-
- };
+
+ };
} // namespace ZThread