f6bcfd974e
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@7748 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
75 lines
1.9 KiB
TeX
75 lines
1.9 KiB
TeX
\section{\class{wxCondition}}\label{wxcondition}
|
|
|
|
wxCondition variables correspond to pthread conditions or to Win32 event
|
|
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 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.
|
|
|
|
\wxheading{Include files}
|
|
|
|
<wx/thread.h>
|
|
|
|
\wxheading{See also}
|
|
|
|
\helpref{wxThread}{wxthread}, \helpref{wxMutex}{wxmutex}
|
|
|
|
\latexignore{\rtfignore{\wxheading{Members}}}
|
|
|
|
\membersection{wxCondition::wxCondition}\label{wxconditionconstr}
|
|
|
|
\func{}{wxCondition}{\void}
|
|
|
|
Default constructor.
|
|
|
|
\membersection{wxCondition::\destruct{wxCondition}}
|
|
|
|
\func{}{\destruct{wxCondition}}{\void}
|
|
|
|
Destroys the wxCondition object.
|
|
|
|
\membersection{wxCondition::Broadcast}\label{wxconditionbroadcast}
|
|
|
|
\func{void}{Broadcast}{\void}
|
|
|
|
Broadcasts to all waiting objects.
|
|
|
|
\membersection{wxCondition::Signal}\label{wxconditionsignal}
|
|
|
|
\func{void}{Signal}{\void}
|
|
|
|
Signals the object.
|
|
|
|
\membersection{wxCondition::Wait}\label{wxconditionwait}
|
|
|
|
\func{void}{Wait}{\void}
|
|
|
|
Waits indefinitely.
|
|
|
|
\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{sec}{Timeout in seconds}
|
|
|
|
\docparam{nsec}{Timeout nanoseconds component (added to {\it sec}).}
|
|
|
|
\wxheading{Return value}
|
|
|
|
The second form returns if the signal was raised, or FALSE if there was a timeout.
|
|
|