Subversion Repositories public

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
3 luk 1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3
<title>inotify-cxx: Inotify Class Reference</title>
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
5
</head><body>
6
<!-- Generated by Doxygen 1.4.4 -->
7
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
8
<h1>Inotify Class Reference</h1><!-- doxytag: class="Inotify" -->inotify class  
9
<a href="#_details">More...</a>
10
<p>
11
<code>#include &lt;<a class="el" href="inotify-cxx_8h-source.html">inotify-cxx.h</a>&gt;</code>
12
<p>
13
<a href="classInotify-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
14
<tr><td></td></tr>
15
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
16
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInotify.html#a0">Inotify</a> ()</td></tr>
17
 
18
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#a0"></a><br></td></tr>
19
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInotify.html#a1">~Inotify</a> ()</td></tr>
20
 
21
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor.  <a href="#a1"></a><br></td></tr>
22
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInotify.html#a2">Close</a> ()</td></tr>
23
 
24
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Removes all watches and closes the inotify device.  <a href="#a2"></a><br></td></tr>
25
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInotify.html#a3">IsReady</a> () const </td></tr>
26
 
27
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Checks whether the inotify is ready.  <a href="#a3"></a><br></td></tr>
28
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInotify.html#a4">Add</a> (<a class="el" href="classInotifyWatch.html">InotifyWatch</a> *pWatch)</td></tr>
29
 
30
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds a new watch.  <a href="#a4"></a><br></td></tr>
31
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInotify.html#a5">Add</a> (<a class="el" href="classInotifyWatch.html">InotifyWatch</a> &amp;rWatch)</td></tr>
32
 
33
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds a new watch.  <a href="#a5"></a><br></td></tr>
34
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInotify.html#a6">Remove</a> (<a class="el" href="classInotifyWatch.html">InotifyWatch</a> *pWatch)</td></tr>
35
 
36
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Removes a watch.  <a href="#a6"></a><br></td></tr>
37
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInotify.html#a7">Remove</a> (<a class="el" href="classInotifyWatch.html">InotifyWatch</a> &amp;rWatch)</td></tr>
38
 
39
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Removes a watch.  <a href="#a7"></a><br></td></tr>
40
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInotify.html#a8">RemoveAll</a> ()</td></tr>
41
 
42
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Removes all watches.  <a href="#a8"></a><br></td></tr>
43
<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInotify.html#a9">GetWatchCount</a> () const </td></tr>
44
 
45
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the count of watches.  <a href="#a9"></a><br></td></tr>
46
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInotify.html#a10">WaitForEvents</a> (bool fNoIntr=false)</td></tr>
47
 
48
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Waits for inotify events.  <a href="#a10"></a><br></td></tr>
49
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInotify.html#a11">GetEventCount</a> ()</td></tr>
50
 
51
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the count of received and queued events.  <a href="#a11"></a><br></td></tr>
52
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInotify.html#a12">GetEvent</a> (<a class="el" href="classInotifyEvent.html">InotifyEvent</a> *pEvt)</td></tr>
53
 
54
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Extracts a queued inotify event.  <a href="#a12"></a><br></td></tr>
55
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInotify.html#a13">GetEvent</a> (<a class="el" href="classInotifyEvent.html">InotifyEvent</a> &amp;rEvt)</td></tr>
56
 
57
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Extracts a queued inotify event.  <a href="#a13"></a><br></td></tr>
58
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInotify.html#a14">PeekEvent</a> (<a class="el" href="classInotifyEvent.html">InotifyEvent</a> *pEvt)</td></tr>
59
 
60
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Extracts a queued inotify event (without removing).  <a href="#a14"></a><br></td></tr>
61
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInotify.html#a15">PeekEvent</a> (<a class="el" href="classInotifyEvent.html">InotifyEvent</a> &amp;rEvt)</td></tr>
62
 
63
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Extracts a queued inotify event (without removing).  <a href="#a15"></a><br></td></tr>
64
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classInotifyWatch.html">InotifyWatch</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInotify.html#a16">FindWatch</a> (int iDescriptor)</td></tr>
65
 
66
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Searches for a watch.  <a href="#a16"></a><br></td></tr>
67
</table>
68
<hr><a name="_details"></a><h2>Detailed Description</h2>
69
inotify class
70
<p>
71
<hr><h2>Constructor &amp; Destructor Documentation</h2>
72
<a class="anchor" name="a0"></a><!-- doxytag: member="Inotify::Inotify" ref="a0" args="()" --><p>
73
<table class="mdTable" cellpadding="2" cellspacing="0">
74
  <tr>
75
    <td class="mdRow">
76
      <table cellpadding="0" cellspacing="0" border="0">
77
        <tr>
78
          <td class="md" nowrap valign="top">Inotify::Inotify           </td>
79
          <td class="md" valign="top">(&nbsp;</td>
80
          <td class="mdname1" valign="top" nowrap>          </td>
81
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
82
          <td class="md" nowrap></td>
83
        </tr>
84
      </table>
85
    </td>
86
  </tr>
87
</table>
88
<table cellspacing="5" cellpadding="0" border="0">
89
  <tr>
90
    <td>
91
      &nbsp;
92
    </td>
93
    <td>
94
 
95
<p>
96
Constructor.
97
<p>
98
Creates and initializes an instance of inotify communication object (opens the inotify device).    </td>
99
  </tr>
100
</table>
101
<a class="anchor" name="a1"></a><!-- doxytag: member="Inotify::~Inotify" ref="a1" args="()" --><p>
102
<table class="mdTable" cellpadding="2" cellspacing="0">
103
  <tr>
104
    <td class="mdRow">
105
      <table cellpadding="0" cellspacing="0" border="0">
106
        <tr>
107
          <td class="md" nowrap valign="top">Inotify::~Inotify           </td>
108
          <td class="md" valign="top">(&nbsp;</td>
109
          <td class="mdname1" valign="top" nowrap>          </td>
110
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
111
          <td class="md" nowrap></td>
112
        </tr>
113
      </table>
114
    </td>
115
  </tr>
116
</table>
117
<table cellspacing="5" cellpadding="0" border="0">
118
  <tr>
119
    <td>
120
      &nbsp;
121
    </td>
122
    <td>
123
 
124
<p>
125
Destructor.
126
<p>
127
Calls <a class="el" href="classInotify.html#a2">Close()</a> due for clean-up.    </td>
128
  </tr>
129
</table>
130
<hr><h2>Member Function Documentation</h2>
131
<a class="anchor" name="a5"></a><!-- doxytag: member="Inotify::Add" ref="a5" args="(InotifyWatch &amp;rWatch)" --><p>
132
<table class="mdTable" cellpadding="2" cellspacing="0">
133
  <tr>
134
    <td class="mdRow">
135
      <table cellpadding="0" cellspacing="0" border="0">
136
        <tr>
137
          <td class="md" nowrap valign="top">bool Inotify::Add           </td>
138
          <td class="md" valign="top">(&nbsp;</td>
139
          <td class="md" nowrap valign="top"><a class="el" href="classInotifyWatch.html">InotifyWatch</a> &amp;&nbsp;</td>
140
          <td class="mdname1" valign="top" nowrap> <em>rWatch</em>          </td>
141
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
142
          <td class="md" nowrap><code> [inline]</code></td>
143
        </tr>
144
      </table>
145
    </td>
146
  </tr>
147
</table>
148
<table cellspacing="5" cellpadding="0" border="0">
149
  <tr>
150
    <td>
151
      &nbsp;
152
    </td>
153
    <td>
154
 
155
<p>
156
Adds a new watch.
157
<p>
158
<dl compact><dt><b>Parameters:</b></dt><dd>
159
  <table border="0" cellspacing="2" cellpadding="0">
160
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>rWatch</em>&nbsp;</td><td>inotify watch </td></tr>
161
  </table>
162
</dl>
163
<dl compact><dt><b>Returns:</b></dt><dd>true = success, false = failure</dd></dl>
164
    </td>
165
  </tr>
166
</table>
167
<a class="anchor" name="a4"></a><!-- doxytag: member="Inotify::Add" ref="a4" args="(InotifyWatch *pWatch)" --><p>
168
<table class="mdTable" cellpadding="2" cellspacing="0">
169
  <tr>
170
    <td class="mdRow">
171
      <table cellpadding="0" cellspacing="0" border="0">
172
        <tr>
173
          <td class="md" nowrap valign="top">bool Inotify::Add           </td>
174
          <td class="md" valign="top">(&nbsp;</td>
175
          <td class="md" nowrap valign="top"><a class="el" href="classInotifyWatch.html">InotifyWatch</a> *&nbsp;</td>
176
          <td class="mdname1" valign="top" nowrap> <em>pWatch</em>          </td>
177
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
178
          <td class="md" nowrap></td>
179
        </tr>
180
      </table>
181
    </td>
182
  </tr>
183
</table>
184
<table cellspacing="5" cellpadding="0" border="0">
185
  <tr>
186
    <td>
187
      &nbsp;
188
    </td>
189
    <td>
190
 
191
<p>
192
Adds a new watch.
193
<p>
194
<dl compact><dt><b>Parameters:</b></dt><dd>
195
  <table border="0" cellspacing="2" cellpadding="0">
196
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>pWatch</em>&nbsp;</td><td>inotify watch </td></tr>
197
  </table>
198
</dl>
199
<dl compact><dt><b>Returns:</b></dt><dd>true = success, false = failure</dd></dl>
200
    </td>
201
  </tr>
202
</table>
203
<a class="anchor" name="a2"></a><!-- doxytag: member="Inotify::Close" ref="a2" args="()" --><p>
204
<table class="mdTable" cellpadding="2" cellspacing="0">
205
  <tr>
206
    <td class="mdRow">
207
      <table cellpadding="0" cellspacing="0" border="0">
208
        <tr>
209
          <td class="md" nowrap valign="top">void Inotify::Close           </td>
210
          <td class="md" valign="top">(&nbsp;</td>
211
          <td class="mdname1" valign="top" nowrap>          </td>
212
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
213
          <td class="md" nowrap></td>
214
        </tr>
215
      </table>
216
    </td>
217
  </tr>
218
</table>
219
<table cellspacing="5" cellpadding="0" border="0">
220
  <tr>
221
    <td>
222
      &nbsp;
223
    </td>
224
    <td>
225
 
226
<p>
227
Removes all watches and closes the inotify device.
228
<p>
229
    </td>
230
  </tr>
231
</table>
232
<a class="anchor" name="a16"></a><!-- doxytag: member="Inotify::FindWatch" ref="a16" args="(int iDescriptor)" --><p>
233
<table class="mdTable" cellpadding="2" cellspacing="0">
234
  <tr>
235
    <td class="mdRow">
236
      <table cellpadding="0" cellspacing="0" border="0">
237
        <tr>
238
          <td class="md" nowrap valign="top"><a class="el" href="classInotifyWatch.html">InotifyWatch</a> * Inotify::FindWatch           </td>
239
          <td class="md" valign="top">(&nbsp;</td>
240
          <td class="md" nowrap valign="top">int&nbsp;</td>
241
          <td class="mdname1" valign="top" nowrap> <em>iDescriptor</em>          </td>
242
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
243
          <td class="md" nowrap></td>
244
        </tr>
245
      </table>
246
    </td>
247
  </tr>
248
</table>
249
<table cellspacing="5" cellpadding="0" border="0">
250
  <tr>
251
    <td>
252
      &nbsp;
253
    </td>
254
    <td>
255
 
256
<p>
257
Searches for a watch.
258
<p>
259
It tries to find a watch by the given descriptor.<p>
260
<dl compact><dt><b>Parameters:</b></dt><dd>
261
  <table border="0" cellspacing="2" cellpadding="0">
262
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>iDescriptor</em>&nbsp;</td><td>watch descriptor </td></tr>
263
  </table>
264
</dl>
265
<dl compact><dt><b>Returns:</b></dt><dd>found descriptor; NULL if no such watch exists</dd></dl>
266
    </td>
267
  </tr>
268
</table>
269
<a class="anchor" name="a13"></a><!-- doxytag: member="Inotify::GetEvent" ref="a13" args="(InotifyEvent &amp;rEvt)" --><p>
270
<table class="mdTable" cellpadding="2" cellspacing="0">
271
  <tr>
272
    <td class="mdRow">
273
      <table cellpadding="0" cellspacing="0" border="0">
274
        <tr>
275
          <td class="md" nowrap valign="top">bool Inotify::GetEvent           </td>
276
          <td class="md" valign="top">(&nbsp;</td>
277
          <td class="md" nowrap valign="top"><a class="el" href="classInotifyEvent.html">InotifyEvent</a> &amp;&nbsp;</td>
278
          <td class="mdname1" valign="top" nowrap> <em>rEvt</em>          </td>
279
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
280
          <td class="md" nowrap><code> [inline]</code></td>
281
        </tr>
282
      </table>
283
    </td>
284
  </tr>
285
</table>
286
<table cellspacing="5" cellpadding="0" border="0">
287
  <tr>
288
    <td>
289
      &nbsp;
290
    </td>
291
    <td>
292
 
293
<p>
294
Extracts a queued inotify event.
295
<p>
296
The extracted event is removed from the queue.<p>
297
<dl compact><dt><b>Parameters:</b></dt><dd>
298
  <table border="0" cellspacing="2" cellpadding="0">
299
    <tr><td valign="top"><tt>[in,out]</tt>&nbsp;</td><td valign="top"><em>rEvt</em>&nbsp;</td><td>event object </td></tr>
300
  </table>
301
</dl>
302
<dl compact><dt><b>Returns:</b></dt><dd>true = success, false = failure</dd></dl>
303
    </td>
304
  </tr>
305
</table>
306
<a class="anchor" name="a12"></a><!-- doxytag: member="Inotify::GetEvent" ref="a12" args="(InotifyEvent *pEvt)" --><p>
307
<table class="mdTable" cellpadding="2" cellspacing="0">
308
  <tr>
309
    <td class="mdRow">
310
      <table cellpadding="0" cellspacing="0" border="0">
311
        <tr>
312
          <td class="md" nowrap valign="top">bool Inotify::GetEvent           </td>
313
          <td class="md" valign="top">(&nbsp;</td>
314
          <td class="md" nowrap valign="top"><a class="el" href="classInotifyEvent.html">InotifyEvent</a> *&nbsp;</td>
315
          <td class="mdname1" valign="top" nowrap> <em>pEvt</em>          </td>
316
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
317
          <td class="md" nowrap></td>
318
        </tr>
319
      </table>
320
    </td>
321
  </tr>
322
</table>
323
<table cellspacing="5" cellpadding="0" border="0">
324
  <tr>
325
    <td>
326
      &nbsp;
327
    </td>
328
    <td>
329
 
330
<p>
331
Extracts a queued inotify event.
332
<p>
333
The extracted event is removed from the queue. If the pointer is NULL it does nothing.<p>
334
<dl compact><dt><b>Parameters:</b></dt><dd>
335
  <table border="0" cellspacing="2" cellpadding="0">
336
    <tr><td valign="top"><tt>[in,out]</tt>&nbsp;</td><td valign="top"><em>pEvt</em>&nbsp;</td><td>event object </td></tr>
337
  </table>
338
</dl>
339
<dl compact><dt><b>Returns:</b></dt><dd>true = success, false = failure</dd></dl>
340
    </td>
341
  </tr>
342
</table>
343
<a class="anchor" name="a11"></a><!-- doxytag: member="Inotify::GetEventCount" ref="a11" args="()" --><p>
344
<table class="mdTable" cellpadding="2" cellspacing="0">
345
  <tr>
346
    <td class="mdRow">
347
      <table cellpadding="0" cellspacing="0" border="0">
348
        <tr>
349
          <td class="md" nowrap valign="top">int Inotify::GetEventCount           </td>
350
          <td class="md" valign="top">(&nbsp;</td>
351
          <td class="mdname1" valign="top" nowrap>          </td>
352
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
353
          <td class="md" nowrap></td>
354
        </tr>
355
      </table>
356
    </td>
357
  </tr>
358
</table>
359
<table cellspacing="5" cellpadding="0" border="0">
360
  <tr>
361
    <td>
362
      &nbsp;
363
    </td>
364
    <td>
365
 
366
<p>
367
Returns the count of received and queued events.
368
<p>
369
This number is related to the events in the queue inside this object, not to the events pending in the kernel.<p>
370
<dl compact><dt><b>Returns:</b></dt><dd>count of events</dd></dl>
371
    </td>
372
  </tr>
373
</table>
374
<a class="anchor" name="a9"></a><!-- doxytag: member="Inotify::GetWatchCount" ref="a9" args="() const " --><p>
375
<table class="mdTable" cellpadding="2" cellspacing="0">
376
  <tr>
377
    <td class="mdRow">
378
      <table cellpadding="0" cellspacing="0" border="0">
379
        <tr>
380
          <td class="md" nowrap valign="top">size_t Inotify::GetWatchCount           </td>
381
          <td class="md" valign="top">(&nbsp;</td>
382
          <td class="mdname1" valign="top" nowrap>          </td>
383
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
384
          <td class="md" nowrap> const<code> [inline]</code></td>
385
        </tr>
386
      </table>
387
    </td>
388
  </tr>
389
</table>
390
<table cellspacing="5" cellpadding="0" border="0">
391
  <tr>
392
    <td>
393
      &nbsp;
394
    </td>
395
    <td>
396
 
397
<p>
398
Returns the count of watches.
399
<p>
400
<dl compact><dt><b>Returns:</b></dt><dd>count of watches</dd></dl>
401
    </td>
402
  </tr>
403
</table>
404
<a class="anchor" name="a3"></a><!-- doxytag: member="Inotify::IsReady" ref="a3" args="() const " --><p>
405
<table class="mdTable" cellpadding="2" cellspacing="0">
406
  <tr>
407
    <td class="mdRow">
408
      <table cellpadding="0" cellspacing="0" border="0">
409
        <tr>
410
          <td class="md" nowrap valign="top">bool Inotify::IsReady           </td>
411
          <td class="md" valign="top">(&nbsp;</td>
412
          <td class="mdname1" valign="top" nowrap>          </td>
413
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
414
          <td class="md" nowrap> const<code> [inline]</code></td>
415
        </tr>
416
      </table>
417
    </td>
418
  </tr>
419
</table>
420
<table cellspacing="5" cellpadding="0" border="0">
421
  <tr>
422
    <td>
423
      &nbsp;
424
    </td>
425
    <td>
426
 
427
<p>
428
Checks whether the inotify is ready.
429
<p>
430
<dl compact><dt><b>Returns:</b></dt><dd>true = initialized properly, false = something failed</dd></dl>
431
    </td>
432
  </tr>
433
</table>
434
<a class="anchor" name="a15"></a><!-- doxytag: member="Inotify::PeekEvent" ref="a15" args="(InotifyEvent &amp;rEvt)" --><p>
435
<table class="mdTable" cellpadding="2" cellspacing="0">
436
  <tr>
437
    <td class="mdRow">
438
      <table cellpadding="0" cellspacing="0" border="0">
439
        <tr>
440
          <td class="md" nowrap valign="top">bool Inotify::PeekEvent           </td>
441
          <td class="md" valign="top">(&nbsp;</td>
442
          <td class="md" nowrap valign="top"><a class="el" href="classInotifyEvent.html">InotifyEvent</a> &amp;&nbsp;</td>
443
          <td class="mdname1" valign="top" nowrap> <em>rEvt</em>          </td>
444
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
445
          <td class="md" nowrap><code> [inline]</code></td>
446
        </tr>
447
      </table>
448
    </td>
449
  </tr>
450
</table>
451
<table cellspacing="5" cellpadding="0" border="0">
452
  <tr>
453
    <td>
454
      &nbsp;
455
    </td>
456
    <td>
457
 
458
<p>
459
Extracts a queued inotify event (without removing).
460
<p>
461
The extracted event stays in the queue.<p>
462
<dl compact><dt><b>Parameters:</b></dt><dd>
463
  <table border="0" cellspacing="2" cellpadding="0">
464
    <tr><td valign="top"><tt>[in,out]</tt>&nbsp;</td><td valign="top"><em>rEvt</em>&nbsp;</td><td>event object </td></tr>
465
  </table>
466
</dl>
467
<dl compact><dt><b>Returns:</b></dt><dd>true = success, false = failure</dd></dl>
468
    </td>
469
  </tr>
470
</table>
471
<a class="anchor" name="a14"></a><!-- doxytag: member="Inotify::PeekEvent" ref="a14" args="(InotifyEvent *pEvt)" --><p>
472
<table class="mdTable" cellpadding="2" cellspacing="0">
473
  <tr>
474
    <td class="mdRow">
475
      <table cellpadding="0" cellspacing="0" border="0">
476
        <tr>
477
          <td class="md" nowrap valign="top">bool Inotify::PeekEvent           </td>
478
          <td class="md" valign="top">(&nbsp;</td>
479
          <td class="md" nowrap valign="top"><a class="el" href="classInotifyEvent.html">InotifyEvent</a> *&nbsp;</td>
480
          <td class="mdname1" valign="top" nowrap> <em>pEvt</em>          </td>
481
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
482
          <td class="md" nowrap></td>
483
        </tr>
484
      </table>
485
    </td>
486
  </tr>
487
</table>
488
<table cellspacing="5" cellpadding="0" border="0">
489
  <tr>
490
    <td>
491
      &nbsp;
492
    </td>
493
    <td>
494
 
495
<p>
496
Extracts a queued inotify event (without removing).
497
<p>
498
The extracted event stays in the queue. If the pointer is NULL it does nothing.<p>
499
<dl compact><dt><b>Parameters:</b></dt><dd>
500
  <table border="0" cellspacing="2" cellpadding="0">
501
    <tr><td valign="top"><tt>[in,out]</tt>&nbsp;</td><td valign="top"><em>pEvt</em>&nbsp;</td><td>event object </td></tr>
502
  </table>
503
</dl>
504
<dl compact><dt><b>Returns:</b></dt><dd>true = success, false = failure</dd></dl>
505
    </td>
506
  </tr>
507
</table>
508
<a class="anchor" name="a7"></a><!-- doxytag: member="Inotify::Remove" ref="a7" args="(InotifyWatch &amp;rWatch)" --><p>
509
<table class="mdTable" cellpadding="2" cellspacing="0">
510
  <tr>
511
    <td class="mdRow">
512
      <table cellpadding="0" cellspacing="0" border="0">
513
        <tr>
514
          <td class="md" nowrap valign="top">void Inotify::Remove           </td>
515
          <td class="md" valign="top">(&nbsp;</td>
516
          <td class="md" nowrap valign="top"><a class="el" href="classInotifyWatch.html">InotifyWatch</a> &amp;&nbsp;</td>
517
          <td class="mdname1" valign="top" nowrap> <em>rWatch</em>          </td>
518
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
519
          <td class="md" nowrap><code> [inline]</code></td>
520
        </tr>
521
      </table>
522
    </td>
523
  </tr>
524
</table>
525
<table cellspacing="5" cellpadding="0" border="0">
526
  <tr>
527
    <td>
528
      &nbsp;
529
    </td>
530
    <td>
531
 
532
<p>
533
Removes a watch.
534
<p>
535
If the given watch is not present it does nothing.<p>
536
<dl compact><dt><b>Parameters:</b></dt><dd>
537
  <table border="0" cellspacing="2" cellpadding="0">
538
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>rWatch</em>&nbsp;</td><td>inotify watch</td></tr>
539
  </table>
540
</dl>
541
    </td>
542
  </tr>
543
</table>
544
<a class="anchor" name="a6"></a><!-- doxytag: member="Inotify::Remove" ref="a6" args="(InotifyWatch *pWatch)" --><p>
545
<table class="mdTable" cellpadding="2" cellspacing="0">
546
  <tr>
547
    <td class="mdRow">
548
      <table cellpadding="0" cellspacing="0" border="0">
549
        <tr>
550
          <td class="md" nowrap valign="top">void Inotify::Remove           </td>
551
          <td class="md" valign="top">(&nbsp;</td>
552
          <td class="md" nowrap valign="top"><a class="el" href="classInotifyWatch.html">InotifyWatch</a> *&nbsp;</td>
553
          <td class="mdname1" valign="top" nowrap> <em>pWatch</em>          </td>
554
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
555
          <td class="md" nowrap></td>
556
        </tr>
557
      </table>
558
    </td>
559
  </tr>
560
</table>
561
<table cellspacing="5" cellpadding="0" border="0">
562
  <tr>
563
    <td>
564
      &nbsp;
565
    </td>
566
    <td>
567
 
568
<p>
569
Removes a watch.
570
<p>
571
If the given watch is not present it does nothing.<p>
572
<dl compact><dt><b>Parameters:</b></dt><dd>
573
  <table border="0" cellspacing="2" cellpadding="0">
574
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>pWatch</em>&nbsp;</td><td>inotify watch</td></tr>
575
  </table>
576
</dl>
577
    </td>
578
  </tr>
579
</table>
580
<a class="anchor" name="a8"></a><!-- doxytag: member="Inotify::RemoveAll" ref="a8" args="()" --><p>
581
<table class="mdTable" cellpadding="2" cellspacing="0">
582
  <tr>
583
    <td class="mdRow">
584
      <table cellpadding="0" cellspacing="0" border="0">
585
        <tr>
586
          <td class="md" nowrap valign="top">void Inotify::RemoveAll           </td>
587
          <td class="md" valign="top">(&nbsp;</td>
588
          <td class="mdname1" valign="top" nowrap>          </td>
589
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
590
          <td class="md" nowrap></td>
591
        </tr>
592
      </table>
593
    </td>
594
  </tr>
595
</table>
596
<table cellspacing="5" cellpadding="0" border="0">
597
  <tr>
598
    <td>
599
      &nbsp;
600
    </td>
601
    <td>
602
 
603
<p>
604
Removes all watches.
605
<p>
606
    </td>
607
  </tr>
608
</table>
609
<a class="anchor" name="a10"></a><!-- doxytag: member="Inotify::WaitForEvents" ref="a10" args="(bool fNoIntr=false)" --><p>
610
<table class="mdTable" cellpadding="2" cellspacing="0">
611
  <tr>
612
    <td class="mdRow">
613
      <table cellpadding="0" cellspacing="0" border="0">
614
        <tr>
615
          <td class="md" nowrap valign="top">bool Inotify::WaitForEvents           </td>
616
          <td class="md" valign="top">(&nbsp;</td>
617
          <td class="md" nowrap valign="top">bool&nbsp;</td>
618
          <td class="mdname1" valign="top" nowrap> <em>fNoIntr</em> = <code>false</code>          </td>
619
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
620
          <td class="md" nowrap></td>
621
        </tr>
622
      </table>
623
    </td>
624
  </tr>
625
</table>
626
<table cellspacing="5" cellpadding="0" border="0">
627
  <tr>
628
    <td>
629
      &nbsp;
630
    </td>
631
    <td>
632
 
633
<p>
634
Waits for inotify events.
635
<p>
636
It waits until one or more events occur.<p>
637
<dl compact><dt><b>Parameters:</b></dt><dd>
638
  <table border="0" cellspacing="2" cellpadding="0">
639
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>fNoIntr</em>&nbsp;</td><td>if true it re-calls the system call after a handled signal </td></tr>
640
  </table>
641
</dl>
642
<dl compact><dt><b>Returns:</b></dt><dd>true = event(s) occurred, false = failure</dd></dl>
643
    </td>
644
  </tr>
645
</table>
646
<hr>The documentation for this class was generated from the following files:<ul>
647
<li><a class="el" href="inotify-cxx_8h-source.html">inotify-cxx.h</a><li><a class="el" href="inotify-cxx_8cpp.html">inotify-cxx.cpp</a></ul>
648
<hr size="1"><address style="align: right;"><small>Generated on Mon Sep 4 22:30:17 2006 for inotify-cxx by&nbsp;
649
<a href="http://www.doxygen.org/index.html">
650
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4 </small></address>
651
</body>
652
</html>