diff options
Diffstat (limited to 'doc/html/tqmutex.html')
| -rw-r--r-- | doc/html/tqmutex.html | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/html/tqmutex.html b/doc/html/tqmutex.html index 54f7f93a5..164b7a091 100644 --- a/doc/html/tqmutex.html +++ b/doc/html/tqmutex.html @@ -37,7 +37,7 @@ body { background: #ffffff; color: black; } <p><a href="tqmutex-members.html">List of all member functions.</a> <h2>Public Members</h2> <ul> -<li class=fn><a href="#TQMutex"><b>TQMutex</b></a> ( bool recursive = FALSE )</li> +<li class=fn><a href="#TQMutex"><b>TQMutex</b></a> ( bool recursive = false )</li> <li class=fn>virtual <a href="#~TQMutex"><b>~TQMutex</b></a> ()</li> <li class=fn>void <a href="#lock"><b>lock</b></a> ()</li> <li class=fn>void <a href="#unlock"><b>unlock</b></a> ()</li> @@ -133,11 +133,11 @@ lock calls <a href="#unlock">unlock</a>(). A non-blocking alternative to lock() <p>See also <a href="environment.html">Environment Classes</a> and <a href="thread.html">Threading</a>. <hr><h2>Member Function Documentation</h2> -<h3 class=fn><a name="TQMutex"></a>TQMutex::TQMutex ( bool recursive = FALSE ) +<h3 class=fn><a name="TQMutex"></a>TQMutex::TQMutex ( bool recursive = false ) </h3> Constructs a new mutex. The mutex is created in an unlocked state. -A recursive mutex is created if <em>recursive</em> is TRUE; a normal -mutex is created if <em>recursive</em> is FALSE (the default). With a +A recursive mutex is created if <em>recursive</em> is true; a normal +mutex is created if <em>recursive</em> is false (the default). With a recursive mutex, a thread can lock the same mutex multiple times and it will not be unlocked until a corresponding number of <a href="#unlock">unlock</a>() calls have been made. @@ -156,8 +156,8 @@ then this call will <em>block</em> until that thread has unlocked it. <h3 class=fn>bool <a name="locked"></a>TQMutex::locked () </h3> -Returns TRUE if the mutex is locked by another thread; otherwise -returns FALSE. +Returns true if the mutex is locked by another thread; otherwise +returns false. <p> <b>Warning:</b> Due to differing implementations of recursive mutexes on various platforms, calling this function from the same thread that previously locked the mutex will return undefined results. @@ -166,8 +166,8 @@ previously locked the mutex will return undefined results. <h3 class=fn>bool <a name="tryLock"></a>TQMutex::tryLock () </h3> Attempt to lock the mutex. If the lock was obtained, this function -returns TRUE. If another thread has locked the mutex, this -function returns FALSE, instead of waiting for the mutex to become +returns true. If another thread has locked the mutex, this +function returns false, instead of waiting for the mutex to become available, i.e. it does not block. <p> If the lock was obtained, the mutex must be unlocked with <a href="#unlock">unlock</a>() before another thread can successfully lock it. |