Subversion Repositories public

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
6 luk 1
.TH "InotifyEvent" 3 "4 Sep 2006" "Version 0.1.0" "inotify-cxx" \" -*- nroff -*-
2
.ad l
3
.nh
4
.SH NAME
5
InotifyEvent \- inotify event class
6
 
7
.PP
8
.SH SYNOPSIS
9
.br
10
.PP
11
\fC#include <inotify-cxx.h>\fP
12
.PP
13
.SS "Public Member Functions"
14
 
15
.in +1c
16
.ti -1c
17
.RI "\fBInotifyEvent\fP ()"
18
.br
19
.RI "\fIConstructor. \fP"
20
.ti -1c
21
.RI "\fBInotifyEvent\fP (const struct inotify_event *pEvt)"
22
.br
23
.RI "\fIConstructor. \fP"
24
.ti -1c
25
.RI "\fB~InotifyEvent\fP ()"
26
.br
27
.RI "\fIDestructor. \fP"
28
.ti -1c
29
.RI "int32_t \fBGetDescriptor\fP () const "
30
.br
31
.RI "\fIReturns the event watch descriptor. \fP"
32
.ti -1c
33
.RI "uint32_t \fBGetMask\fP () const "
34
.br
35
.RI "\fIReturns the event mask. \fP"
36
.ti -1c
37
.RI "bool \fBIsType\fP (uint32_t uType) const "
38
.br
39
.RI "\fIChecks for the event type. \fP"
40
.ti -1c
41
.RI "uint32_t \fBGetCookie\fP () const "
42
.br
43
.RI "\fIReturns the event cookie. \fP"
44
.ti -1c
45
.RI "uint32_t \fBGetLength\fP () const "
46
.br
47
.RI "\fIReturns the event name length. \fP"
48
.ti -1c
49
.RI "const std::string & \fBGetName\fP () const "
50
.br
51
.RI "\fIReturns the event name. \fP"
52
.ti -1c
53
.RI "void \fBGetName\fP (std::string &rName) const "
54
.br
55
.RI "\fIExtracts the event name. \fP"
56
.ti -1c
57
.RI "void \fBGetData\fP (struct inotify_event *pEvt)"
58
.br
59
.RI "\fIReturns the event raw data. \fP"
60
.ti -1c
61
.RI "void \fBGetData\fP (struct inotify_event &rEvt)"
62
.br
63
.RI "\fIReturns the event raw data. \fP"
64
.ti -1c
65
.RI "void \fBDumpTypes\fP (std::string &rStr) const "
66
.br
67
.RI "\fIFills the string with all types contained in the event mask. \fP"
68
.in -1c
69
.SH "Detailed Description"
70
.PP
71
inotify event class
72
 
73
It holds all information about inotify event and provides access to its particular values.
74
.PP
75
.SH "Constructor & Destructor Documentation"
76
.PP
77
.SS "InotifyEvent::InotifyEvent ()\fC [inline]\fP"
78
.PP
79
Constructor.
80
.PP
81
Creates a plain event.
82
.SS "InotifyEvent::InotifyEvent (const struct inotify_event * pEvt)\fC [inline]\fP"
83
.PP
84
Constructor.
85
.PP
86
Creates an event based on inotify event data. For NULL pointer it works the same way as \fBInotifyEvent()\fP.
87
.PP
88
\fBParameters:\fP
89
.RS 4
90
\fIpEvt\fP event data
91
.RE
92
.PP
93
 
94
.SS "InotifyEvent::~InotifyEvent ()\fC [inline]\fP"
95
.PP
96
Destructor.
97
.PP
98
.SH "Member Function Documentation"
99
.PP
100
.SS "void InotifyEvent::DumpTypes (std::string & rStr) const"
101
.PP
102
Fills the string with all types contained in the event mask.
103
.PP
104
\fBParameters:\fP
105
.RS 4
106
\fIrStr\fP dumped event types
107
.RE
108
.PP
109
 
110
.SS "uint32_t InotifyEvent::GetCookie () const\fC [inline]\fP"
111
.PP
112
Returns the event cookie.
113
.PP
114
\fBReturns:\fP
115
.RS 4
116
event cookie
117
.RE
118
.PP
119
 
120
.SS "void InotifyEvent::GetData (struct inotify_event & rEvt)\fC [inline]\fP"
121
.PP
122
Returns the event raw data.
123
.PP
124
\fBParameters:\fP
125
.RS 4
126
\fIrEvt\fP event data
127
.RE
128
.PP
129
 
130
.SS "void InotifyEvent::GetData (struct inotify_event * pEvt)\fC [inline]\fP"
131
.PP
132
Returns the event raw data.
133
.PP
134
For NULL pointer it does nothing.
135
.PP
136
\fBParameters:\fP
137
.RS 4
138
\fIpEvt\fP event data
139
.RE
140
.PP
141
 
142
.SS "int32_t InotifyEvent::GetDescriptor () const\fC [inline]\fP"
143
.PP
144
Returns the event watch descriptor.
145
.PP
146
\fBReturns:\fP
147
.RS 4
148
watch descriptor
149
.RE
150
.PP
151
\fBSee also:\fP
152
.RS 4
153
\fBInotifyWatch::GetDescriptor()\fP
154
.RE
155
.PP
156
 
157
.SS "uint32_t InotifyEvent::GetLength () const\fC [inline]\fP"
158
.PP
159
Returns the event name length.
160
.PP
161
\fBReturns:\fP
162
.RS 4
163
event name length
164
.RE
165
.PP
166
 
167
.SS "uint32_t InotifyEvent::GetMask () const\fC [inline]\fP"
168
.PP
169
Returns the event mask.
170
.PP
171
\fBReturns:\fP
172
.RS 4
173
event mask
174
.RE
175
.PP
176
\fBSee also:\fP
177
.RS 4
178
\fBInotifyWatch::GetMask()\fP
179
.RE
180
.PP
181
 
182
.SS "void InotifyEvent::GetName (std::string & rName) const\fC [inline]\fP"
183
.PP
184
Extracts the event name.
185
.PP
186
\fBParameters:\fP
187
.RS 4
188
\fIrName\fP event name
189
.RE
190
.PP
191
 
192
.SS "const std::string& InotifyEvent::GetName () const\fC [inline]\fP"
193
.PP
194
Returns the event name.
195
.PP
196
\fBReturns:\fP
197
.RS 4
198
event name
199
.RE
200
.PP
201
 
202
.SS "bool InotifyEvent::IsType (uint32_t uType) const\fC [inline]\fP"
203
.PP
204
Checks for the event type.
205
.PP
206
\fBParameters:\fP
207
.RS 4
208
\fIuType\fP type which is checked for
209
.RE
210
.PP
211
\fBReturns:\fP
212
.RS 4
213
true = event mask contains the given type, false = otherwise
214
.RE
215
.PP
216
 
217
 
218
.SH "Author"
219
.PP
220
Generated automatically by Doxygen for inotify-cxx from the source code.