1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
|
.TH "Event" 3 "19 Jul 2003" "CommonC++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Event \- The Event class implements a feature originally found in the WIN32 API; event notification. \fBThread\fP synchornization on event notification.
.SH SYNOPSIS
.br
.PP
\fC#include <thread.h>\fP
.PP
.SS "Public Methods"
.in +1c
.ti -1c
.RI "\fBEvent\fP ()"
.br
.ti -1c
.RI "virtual \fB~Event\fP ()"
.br
.ti -1c
.RI "void \fBreset\fP (void)"
.br
.RI "\fIOnce signaled, the Event class must be 'reset' before responding to a new signal.\fP"
.ti -1c
.RI "void \fBsignal\fP (void)"
.br
.RI "\fISignal the event for the waiting thread.\fP"
.ti -1c
.RI "bool \fBwait\fP (\fBtimeout_t\fP timer)"
.br
.RI "\fIWait either for the event to be signaled by another thread or for the specified timeout duration.\fP"
.ti -1c
.RI "bool \fBwait\fP (void)"
.br
.in -1c
.SH "DETAILED DESCRIPTION"
.PP
The Event class implements a feature originally found in the WIN32 API; event notification. \fBThread\fP synchornization on event notification.
.PP
A target thread waits on a resetable Event, and one or more other threads can then signal the waiting thread to resume execution. A timeout can be used to specify a wait duration in milliseconds. The Event class must be reset before it can be used again as a trigger. These event objects use a trigger/reset mechanism and are related to low level conditional variables.
.PP
@author: David Sugar <dyfet@ostel.com>
.PP
.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION"
.PP
.SS "Event::Event ()"
.PP
.SS "virtual Event::~Event ()\fC [virtual]\fP"
.PP
.SH "MEMBER FUNCTION DOCUMENTATION"
.PP
.SS "void Event::reset (void)"
.PP
Once signaled, the Event class must be 'reset' before responding to a new signal.
.PP
\fBSee also: \fP
.in +1c
\fBsignal\fP
.SS "void Event::signal (void)"
.PP
Signal the event for the waiting thread.
.PP
.SS "bool Event::wait (void)"
.PP
.SS "bool Event::wait (\fBtimeout_t\fP timer)"
.PP
Wait either for the event to be signaled by another thread or for the specified timeout duration.
.PP
\fBSee also: \fP
.in +1c
\fBsignal\fP
.PP
\fBReturns: \fP
.in +1c
true if signaled, false if timed out.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fItimer\fP\fP
timeout in milliseconds to wait for a signal.
.SH "AUTHOR"
.PP
Generated automatically by Doxygen for CommonC++ from the source code.
|
