X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9063ea8ee28601bfa00b6c724847ff22eced970d..8962e1d9383d615ea48979cd76bd53d5aa5b3026:/docs/latex/wx/conditn.tex?ds=sidebyside diff --git a/docs/latex/wx/conditn.tex b/docs/latex/wx/conditn.tex index 777a3cd226..a58d8b5ff4 100644 --- a/docs/latex/wx/conditn.tex +++ b/docs/latex/wx/conditn.tex @@ -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}).}