Use common book flags (and other minor corrections).

[wxWidgets.git] / docs / latex / wx / mutex.tex

diff --git a/docs/latex/wx/mutex.tex b/docs/latex/wx/mutex.tex
index 348ae108c419bf3900586afeb27f1d264f3d903e..5e8275059f51d430997dc001fa0733d4747e2d99 100644 (file)
--- a/docs/latex/wx/mutex.tex
+++ b/docs/latex/wx/mutex.tex
@@ -3,14 +3,18 @@
 A mutex object is a synchronization object whose state is set to signaled when
 it is not owned by any thread, and nonsignaled when it is owned. Its name comes
 from its usefulness in coordinating mutually-exclusive access to a shared
-resource. Only one thread at a time can own a mutex object but the mutexes are
-recursive in the sense that a thread can lock a mutex which it had already
-locked before (instead of dead locking the entire process in this situation by
-starting to wait on a mutex which will never be released while the thread is
-waiting).
-
-For example, when several thread use the data stored in the linked list,
-modifications to the list should be only allowed to one thread at a time
+resource as only one thread at a time can own a mutex object.
+
+Mutexes may be recursive in the sense that a thread can lock a mutex which it
+had already locked before (instead of dead locking the entire process in this
+situation by starting to wait on a mutex which will never be released while the
+thread is waiting) but using them is not recommended and they are {\bf not}
+recursive by default. The reason for this is that recursive mutexes are not
+supported by all Unix flavours and, worse, they cannot be used with 
+\helpref{wxCondition}{wxcondition}.
+
+For example, when several threads use the data stored in the linked list,
+modifications to the list should only be allowed to one thread at a time
 because during a new node addition the list integrity is temporarily broken
 (this is also called {\it program invariant}).
 
@@ -37,7 +41,7 @@ because during a new node addition the list integrity is temporarily broken
         s_mutexProtectingTheGlobalList->Unlock();
     }
 
-    // return TRUE the given number is greater than all array elements
+    // return true the given number is greater than all array elements
     bool MyThread::IsGreater(int num)
     {
         // before using the list we must acquire the mutex
@@ -47,20 +51,33 @@ because during a new node addition the list integrity is temporarily broken
         for ( size_t n = 0; n < count; n++ )
         {
             if ( s_data[n] > num )
-                return FALSE;
+                return false;
         }
 
-        return TRUE;
+        return true;
     }
 \end{verbatim}
 }
 
 Notice how wxMutexLocker was used in the second function to ensure that the
-mutex is unlocked in any case: whether the function returns TRUE or FALSE
+mutex is unlocked in any case: whether the function returns true or false
 (because the destructor of the local object {\it lock} is always called). Using
 this class instead of directly using wxMutex is, in general safer and is even
 more so if your program uses C++ exceptions.
 
+\wxheading{Constants}
+
+\begin{verbatim}
+enum wxMutexType
+{
+    // normal mutex: try to always use this one
+    wxMUTEX_DEFAULT,
+
+    // recursive mutex: don't use these ones with wxCondition
+    wxMUTEX_RECURSIVE
+};
+\end{verbatim}
+
 \wxheading{Derived from}
 
 None.
@@ -76,24 +93,18 @@ None.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxMutex::wxMutex}\label{wxmutexconstr}
+\membersection{wxMutex::wxMutex}\label{wxmutexctor}
 
-\func{}{wxMutex}{\void}
+\func{}{wxMutex}{\param{wxMutexType }{type = {\tt wxMUTEX\_DEFAULT}}}
 
 Default constructor.
 
-\membersection{wxMutex::\destruct{wxMutex}}
+\membersection{wxMutex::\destruct{wxMutex}}\label{wxmutexdtor}
 
 \func{}{\destruct{wxMutex}}{\void}
 
 Destroys the wxMutex object.
 
-\membersection{wxMutex::IsLocked}\label{wxmutexislocked}
-
-\constfunc{bool}{IsLocked}{\void}
-
-Returns TRUE if the mutex is locked, FALSE otherwise.
-
 \membersection{wxMutex::Lock}\label{wxmutexlock}
 
 \func{wxMutexError}{Lock}{\void}
@@ -108,7 +119,6 @@ One of:
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf wxMUTEX\_NO\_ERROR}}{There was no error.}
 \twocolitem{{\bf wxMUTEX\_DEAD\_LOCK}}{A deadlock situation was detected.}
-\twocolitem{{\bf wxMUTEX\_BUSY}}{The mutex is already locked by another thread.}
 \end{twocollist}
 
 \membersection{wxMutex::TryLock}\label{wxmutextrylock}
@@ -124,7 +134,6 @@ One of:
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf wxMUTEX\_NO\_ERROR}}{There was no error.}
-\twocolitem{{\bf wxMUTEX\_DEAD\_LOCK}}{A deadlock situation was detected.}
 \twocolitem{{\bf wxMUTEX\_BUSY}}{The mutex is already locked by another thread.}
 \end{twocollist}
 
@@ -141,8 +150,6 @@ One of:
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf wxMUTEX\_NO\_ERROR}}{There was no error.}
-\twocolitem{{\bf wxMUTEX\_DEAD\_LOCK}}{A deadlock situation was detected.}
-\twocolitem{{\bf wxMUTEX\_BUSY}}{The mutex is already locked by another thread.}
-\twocolitem{{\bf wxMUTEX\_UNLOCKED}}{The calling thread tries to unlock an unlocked mutex.}
+\twocolitem{{\bf wxMUTEX\_UNLOCKED}}{The calling thread doesn't own the mutex.}
 \end{twocollist}