projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| eaaa6a06 JS |
1 | \section{\class{wxCondition}}\label{wxcondition} |
| 2 | ||
| 36edded9 | 3 | Condition class for code protection in multithreaded applications. |
| eaaa6a06 JS |
4 | |
| 5 | \wxheading{Derived from} | |
| 6 | ||
| 7 | None. | |
| 8 | ||
| 954b8ae6 JS |
9 | \wxheading{Include files} |
| 10 | ||
| 11 | <wx/thread.h> | |
| 12 | ||
| eaaa6a06 JS |
13 | \wxheading{See also} |
| 14 | ||
| 15 | \helpref{wxThread}{wxthread}, \helpref{wxMutex}{wxmutex} | |
| 16 | ||
| 17 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 18 | ||
| 19 | \membersection{wxCondition::wxCondition}\label{wxconditionconstr} | |
| 20 | ||
| 21 | \func{}{wxCondition}{\void} | |
| 22 | ||
| 23 | Default constructor. | |
| 24 | ||
| 25 | \membersection{wxCondition::\destruct{wxCondition}} | |
| 26 | ||
| 27 | \func{}{\destruct{wxCondition}}{\void} | |
| 28 | ||
| 29 | Destroys the wxCondition object. | |
| 30 | ||
| 31 | \membersection{wxCondition::Broadcast}\label{wxconditionbroadcast} | |
| 32 | ||
| 33 | \func{void}{Broadcast}{\void} | |
| 34 | ||
| 35 | Broadcasts to all waiting objects. | |
| 36 | ||
| 37 | \membersection{wxCondition::Signal}\label{wxconditionsignal} | |
| 38 | ||
| 39 | \func{void}{Signal}{\void} | |
| 40 | ||
| 41 | Signals the object. | |
| 42 | ||
| 43 | \membersection{wxCondition::Wait}\label{wxconditionwait} | |
| 44 | ||
| 45 | \func{void}{Wait}{\param{wxMutex\&}{ mutex}} | |
| 46 | ||
| 47 | Waits indefinitely. | |
| 48 | ||
| 49 | \func{bool}{Wait}{\param{wxMutex\&}{ mutex}, \param{unsigned long}{ sec}, \param{unsigned long}{ nsec}} | |
| 50 | ||
| 51 | Waits until a signal is raised or the timeout has elapsed. | |
| 52 | ||
| 53 | \wxheading{Parameters} | |
| 54 | ||
| 55 | \docparam{mutex}{wxMutex object.} | |
| 56 | ||
| 57 | \docparam{sec}{Timeout in seconds} | |
| 58 | ||
| 59 | \docparam{nsec}{Timeout nanoseconds component (added to {\it sec}).} | |
| 60 | ||
| 61 | \wxheading{Return value} | |
| 62 | ||
| 63 | The second form returns if the signal was raised, or FALSE if there was a timeout. | |
| 64 |