This commit was manufactured by cvs2svn to create tag 'WX_2_2_9'.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/tags/WX_2_2_9@13364 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -5,12 +5,15 @@ objects. They may be used in a multithreaded application to wait until the
|
||||
given condition becomes true which happens when the condition becomes signaled.
|
||||
|
||||
For example, if a worker thread is doing some long task and another thread has
|
||||
to wait until it's finished, the latter thread will wait on the condition
|
||||
to wait until it is finished, the latter thread will wait on the condition
|
||||
object and the worker thread will signal it on exit (this example is not
|
||||
perfect because in this particular case it would be much better to just
|
||||
\helpref{Wait()}{wxthreadwait} for the worker thread, but if there are several
|
||||
worker threads it already makes much more sense).
|
||||
|
||||
Once the thread(s) are signaled, the condition then resets to the not
|
||||
signaled state, ready to fire again.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
None.
|
||||
@@ -51,18 +54,16 @@ Signals the object.
|
||||
|
||||
\membersection{wxCondition::Wait}\label{wxconditionwait}
|
||||
|
||||
\func{void}{Wait}{\param{wxMutex\&}{ mutex}}
|
||||
\func{void}{Wait}{\void}
|
||||
|
||||
Waits indefinitely.
|
||||
|
||||
\func{bool}{Wait}{\param{wxMutex\&}{ mutex}, \param{unsigned long}{ sec}, \param{unsigned long}{ nsec}}
|
||||
\func{bool}{Wait}{\param{unsigned long}{ sec}, \param{unsigned long}{ nsec}}
|
||||
|
||||
Waits until a signal is raised or the timeout has elapsed.
|
||||
|
||||
\wxheading{Parameters}
|
||||
|
||||
\docparam{mutex}{wxMutex object.}
|
||||
|
||||
\docparam{sec}{Timeout in seconds}
|
||||
|
||||
\docparam{nsec}{Timeout nanoseconds component (added to {\it sec}).}
|
||||
|
Reference in New Issue
Block a user