[wxWidgets.git] / docs / latex / wx / conditn.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's 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).

\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}{\param{wxMutex\&}{ mutex}}

Waits indefinitely.

\func{bool}{Wait}{\param{wxMutex\&}{ mutex}, \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}).}

\wxheading{Return value}

The second form returns if the signal was raised, or FALSE if there was a timeout.
Commit	Line	Data
eaaa6a06 JS	1	\section{\class{wxCondition}}\label{wxcondition}
eaaa6a06 JS	2
9063ea8e VZ	3	wxCondition variables correspond to pthread conditions or to Win32 event
	4	objects. They may be used in a multithreaded application to wait until the
	5	given condition becomes true which happens when the condition becomes signaled.
	6
	7	For example, if a worker thread is doing some long task and another thread has
	8	to wait until it's finished, the latter thread will wait on the condition
	9	object and the worker thread will signal it on exit (this example is not
	10	perfect because in this particular case it would be much better to just
	11	\helpref{Wait()}{wxthreadwait} for the worker thread, but if there are several
	12	worker threads it already makes much more sense).
eaaa6a06 JS	13
	14	\wxheading{Derived from}
	15
	16	None.
	17
954b8ae6 JS	18	\wxheading{Include files}
	19
	20	<wx/thread.h>
	21
eaaa6a06 JS	22	\wxheading{See also}
	23
	24	\helpref{wxThread}{wxthread}, \helpref{wxMutex}{wxmutex}
	25
	26	\latexignore{\rtfignore{\wxheading{Members}}}
	27
	28	\membersection{wxCondition::wxCondition}\label{wxconditionconstr}
	29
	30	\func{}{wxCondition}{\void}
	31
	32	Default constructor.
	33
	34	\membersection{wxCondition::\destruct{wxCondition}}
	35
	36	\func{}{\destruct{wxCondition}}{\void}
	37
	38	Destroys the wxCondition object.
	39
	40	\membersection{wxCondition::Broadcast}\label{wxconditionbroadcast}
	41
	42	\func{void}{Broadcast}{\void}
	43
	44	Broadcasts to all waiting objects.
	45
	46	\membersection{wxCondition::Signal}\label{wxconditionsignal}
	47
	48	\func{void}{Signal}{\void}
	49
	50	Signals the object.
	51
	52	\membersection{wxCondition::Wait}\label{wxconditionwait}
	53
	54	\func{void}{Wait}{\param{wxMutex\&}{ mutex}}
	55
	56	Waits indefinitely.
	57
	58	\func{bool}{Wait}{\param{wxMutex\&}{ mutex}, \param{unsigned long}{ sec}, \param{unsigned long}{ nsec}}
	59
	60	Waits until a signal is raised or the timeout has elapsed.
	61
	62	\wxheading{Parameters}
	63
	64	\docparam{mutex}{wxMutex object.}
	65
	66	\docparam{sec}{Timeout in seconds}
	67
	68	\docparam{nsec}{Timeout nanoseconds component (added to {\it sec}).}
	69
	70	\wxheading{Return value}
	71
	72	The second form returns if the signal was raised, or FALSE if there was a timeout.
	73