corrected m_commandString type to wxString (patch 661648)

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

diff --git a/docs/latex/wx/conditn.tex b/docs/latex/wx/conditn.tex
index bb71a7e7d70671685ed1760b45d0319f7ea952ed..d21d31e55bbf0efc82eb72b48fc6b1e618a7c18e 100644 (file)
--- a/docs/latex/wx/conditn.tex
+++ b/docs/latex/wx/conditn.tex
@@ -22,10 +22,10 @@ This example shows how a main thread may launch a worker thread which starts
 running and then waits until the main thread signals it to continue:
 
 \begin{verbatim}
 running and then waits until the main thread signals it to continue:
 
 \begin{verbatim}

-class MyWaitingThread : public wxThread
+class MySignallingThread : public wxThread

 {
 public:
 {
 public:

-    MyWaitingThread(wxMutex *mutex, wxCondition *condition)
+    MySignallingThread(wxMutex *mutex, wxCondition *condition)

     {
         m_mutex = mutex;
         m_condition = condition;
     {
         m_mutex = mutex;
         m_condition = condition;


@@ -35,45 +35,50 @@ public:
 
     virtual ExitCode Entry()
     {
 
     virtual ExitCode Entry()
     {

-        // wait for the signal from the main thread: it is absolutely necessary
-        // to look the mutex before doing it!
-        m_mutex->Lock();
-        m_condition->Signal();
-        m_mutex->Unlock();
-

         ... do our job ...
 
         ... do our job ...
 

+        // tell the other(s) thread(s) that we're about to terminate: we must
+        // lock the mutex first or we might signal the condition before the
+        // waiting threads start waiting on it!
+        wxMutexLocker lock(m_mutex);
+        m_condition.Broadcast(); // same as Signal() here -- one waiter only
+

         return 0;
     }
 
 private:
     wxCondition *m_condition;
         return 0;
     }
 
 private:
     wxCondition *m_condition;

+    wxMutex *m_mutex;

 };
 
 int main()
 {
     wxMutex mutex;
 };
 
 int main()
 {
     wxMutex mutex;

-    wxCondition condition(&mutex);
-
-    for ( int i = 0; i < 10; i++ )
-    {
-        MyWaitingThread *thread = new MyWaitingThread(&mutex, &condition);
+    wxCondition condition(mutex);

 
 

-        thread->Run();
-    }
+    // the mutex should be initially locked
+    mutex.Lock();

 
 

-    // wake up one of the threads
-    condition.Signal();
+    // create and run the thread but notice that it won't be able to
+    // exit (and signal its exit) before we unlock the mutex below
+    MySignallingThread *thread = new MySignallingThread(&mutex, &condition);

 
 

-    // wake up all the other ones
-    condition.Broadcast();
+    thread->Run();

 
 

-    ... wait until they terminate or do something else ...
+    // wait for the thread termination: Wait() atomically unlocks the mutex
+    // which allows the thread to continue and starts waiting
+    condition.Wait();

 
 

+    // now we can exit

     return 0;
 }
 \end{verbatim}
 
     return 0;
 }
 \end{verbatim}
 

+Of course, here it would be much better to simply use a joinable thread and
+call \helpref{wxThread::Wait}{wxthreadwait} on it, but this example does
+illustrate the importance of properly locking the mutex when using
+wxCondition.
+

 \wxheading{Derived from}
 
 None.
 \wxheading{Derived from}
 
 None.


@@ -90,9 +95,10 @@ None.
 
 \membersection{wxCondition::wxCondition}\label{wxconditionconstr}
 
 
 \membersection{wxCondition::wxCondition}\label{wxconditionconstr}
 

-\func{}{wxCondition}{\param{wxMutex }{*mutex}}
+\func{}{wxCondition}{\param{wxMutex\& }{mutex}}

 
 

-Default and only constructor. The {\it mutex} must be non {\tt NULL}.
+Default and only constructor. The {\it mutex} must be locked by the caller
+before calling \helpref{Wait}{wxconditionwait} function.

 
 \membersection{wxCondition::\destruct{wxCondition}}
 
 
 \membersection{wxCondition::\destruct{wxCondition}}