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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>prelude-timer</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
<link rel="home" href="index.html" title="Prelude library Reference Manual">
<link rel="up" href="ch04.html" title="Others">
<link rel="prev" href="libprelude-prelude-option-wide.html" title="prelude-option-wide">
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="pt01.html" title="Part I. Using libprelude to interoperate with prelude-manager">
<link rel="part" href="pt02.html" title="Part II. Sending events with libprelude">
<link rel="chapter" href="ch01.html" title="The low level IDMEF API">
<link rel="chapter" href="ch02.html" title="The high level IDMEF API">
<link rel="part" href="pt03.html" title="Part III. Reading events from the collector">
<link rel="part" href="pt04.html" title="Part IV. Filtering operation on IDMEF messages">
<link rel="chapter" href="ch03.html" title="Utility functions">
<link rel="chapter" href="ch04.html" title="Others">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libprelude-prelude-option-wide.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch04.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Prelude library Reference Manual</th>
<td> </td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#libprelude-prelude-timer.synopsis" class="shortcut">Top</a>
|
<a href="#libprelude-prelude-timer.description" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libprelude-prelude-timer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libprelude-prelude-timer.top_of_page"></a>prelude-timer</span></h2>
<p>prelude-timer</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libprelude-prelude-timer.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a class="link" href="libprelude-prelude-timer.html#prelude-timer-t" title="prelude_timer_t">prelude_timer_t</a>;
#define <a class="link" href="libprelude-prelude-timer.html#prelude-timer-get-expire" title="prelude_timer_get_expire()">prelude_timer_get_expire</a> (timer)
#define <a class="link" href="libprelude-prelude-timer.html#prelude-timer-get-data" title="prelude_timer_get_data()">prelude_timer_get_data</a> (timer)
#define <a class="link" href="libprelude-prelude-timer.html#prelude-timer-get-callback" title="prelude_timer_get_callback()">prelude_timer_get_callback</a> (timer)
#define <a class="link" href="libprelude-prelude-timer.html#prelude-timer-set-expire" title="prelude_timer_set_expire()">prelude_timer_set_expire</a> (timer, x)
#define <a class="link" href="libprelude-prelude-timer.html#prelude-timer-set-data" title="prelude_timer_set_data()">prelude_timer_set_data</a> (timer, x)
#define <a class="link" href="libprelude-prelude-timer.html#prelude-timer-set-callback" title="prelude_timer_set_callback()">prelude_timer_set_callback</a> (timer, x)
void <a class="link" href="libprelude-prelude-timer.html#prelude-timer-init" title="prelude_timer_init ()">prelude_timer_init</a> (<a class="link" href="libprelude-prelude-timer.html#prelude-timer-t" title="prelude_timer_t">prelude_timer_t</a> *timer);
void <a class="link" href="libprelude-prelude-timer.html#prelude-timer-init-list" title="prelude_timer_init_list ()">prelude_timer_init_list</a> (<a class="link" href="libprelude-prelude-timer.html#prelude-timer-t" title="prelude_timer_t">prelude_timer_t</a> *timer);
void <a class="link" href="libprelude-prelude-timer.html#prelude-timer-reset" title="prelude_timer_reset ()">prelude_timer_reset</a> (<a class="link" href="libprelude-prelude-timer.html#prelude-timer-t" title="prelude_timer_t">prelude_timer_t</a> *timer);
void <a class="link" href="libprelude-prelude-timer.html#prelude-timer-destroy" title="prelude_timer_destroy ()">prelude_timer_destroy</a> (<a class="link" href="libprelude-prelude-timer.html#prelude-timer-t" title="prelude_timer_t">prelude_timer_t</a> *timer);
void <a class="link" href="libprelude-prelude-timer.html#prelude-timer-wake-up" title="prelude_timer_wake_up ()">prelude_timer_wake_up</a> (void);
void <a class="link" href="libprelude-prelude-timer.html#prelude-timer-flush" title="prelude_timer_flush ()">prelude_timer_flush</a> (void);
void <a class="link" href="libprelude-prelude-timer.html#prelude-timer-lock-critical-region" title="prelude_timer_lock_critical_region ()">prelude_timer_lock_critical_region</a> (void);
void <a class="link" href="libprelude-prelude-timer.html#prelude-timer-unlock-critical-region" title="prelude_timer_unlock_critical_region ()">prelude_timer_unlock_critical_region</a>
(void);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="libprelude-prelude-timer.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="libprelude-prelude-timer.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="prelude-timer-t"></a><h3>prelude_timer_t</h3>
<pre class="programlisting">typedef struct {
prelude_list_t list;
int expire;
time_t start_time;
void *data;
void (*function)(void *data);
} prelude_timer_t;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="prelude-timer-get-expire"></a><h3>prelude_timer_get_expire()</h3>
<pre class="programlisting">#define prelude_timer_get_expire(timer) (timer)->expire
</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>timer</code></em> :</span></p></td>
<td>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="prelude-timer-get-data"></a><h3>prelude_timer_get_data()</h3>
<pre class="programlisting">#define prelude_timer_get_data(timer) (timer)->data
</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>timer</code></em> :</span></p></td>
<td>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="prelude-timer-get-callback"></a><h3>prelude_timer_get_callback()</h3>
<pre class="programlisting">#define prelude_timer_get_callback(timer) (timer)->function
</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>timer</code></em> :</span></p></td>
<td>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="prelude-timer-set-expire"></a><h3>prelude_timer_set_expire()</h3>
<pre class="programlisting">#define prelude_timer_set_expire(timer, x) prelude_timer_get_expire((timer)) = (x)
</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>timer</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="prelude-timer-set-data"></a><h3>prelude_timer_set_data()</h3>
<pre class="programlisting">#define prelude_timer_set_data(timer, x) prelude_timer_get_data((timer)) = (x)
</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>timer</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="prelude-timer-set-callback"></a><h3>prelude_timer_set_callback()</h3>
<pre class="programlisting">#define prelude_timer_set_callback(timer, x) prelude_timer_get_callback((timer)) = (x)
</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>timer</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="prelude-timer-init"></a><h3>prelude_timer_init ()</h3>
<pre class="programlisting">void prelude_timer_init (<a class="link" href="libprelude-prelude-timer.html#prelude-timer-t" title="prelude_timer_t">prelude_timer_t</a> *timer);</pre>
<p>
Initialize a timer (add it to the timer list).</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>timer</code></em> :</span></p></td>
<td> timer to initialize.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="prelude-timer-init-list"></a><h3>prelude_timer_init_list ()</h3>
<pre class="programlisting">void prelude_timer_init_list (<a class="link" href="libprelude-prelude-timer.html#prelude-timer-t" title="prelude_timer_t">prelude_timer_t</a> *timer);</pre>
<p>
Initialize <em class="parameter"><code>timer</code></em> list member. This is useful if
you're going to call <a class="link" href="libprelude-prelude-timer.html#prelude-timer-destroy" title="prelude_timer_destroy ()"><code class="function">prelude_timer_destroy()</code></a> on timer
for which <a class="link" href="libprelude-prelude-timer.html#prelude-timer-init" title="prelude_timer_init ()"><code class="function">prelude_timer_init()</code></a> was never called.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>timer</code></em> :</span></p></td>
<td> Pointer to a <a class="link" href="libprelude-prelude-timer.html#prelude-timer-t" title="prelude_timer_t"><span class="type">prelude_timer_t</span></a> object.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="prelude-timer-reset"></a><h3>prelude_timer_reset ()</h3>
<pre class="programlisting">void prelude_timer_reset (<a class="link" href="libprelude-prelude-timer.html#prelude-timer-t" title="prelude_timer_t">prelude_timer_t</a> *timer);</pre>
<p>
Reset timer 'timer', as if it was just started.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>timer</code></em> :</span></p></td>
<td> the timer to reset.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="prelude-timer-destroy"></a><h3>prelude_timer_destroy ()</h3>
<pre class="programlisting">void prelude_timer_destroy (<a class="link" href="libprelude-prelude-timer.html#prelude-timer-t" title="prelude_timer_t">prelude_timer_t</a> *timer);</pre>
<p>
Destroy the timer 'timer',
this remove it from the active timer list.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>timer</code></em> :</span></p></td>
<td> the timer to destroy.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="prelude-timer-wake-up"></a><h3>prelude_timer_wake_up ()</h3>
<pre class="programlisting">void prelude_timer_wake_up (void);</pre>
<p>
Wake up timer that need it.
This function should be called every second to work properly.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="prelude-timer-flush"></a><h3>prelude_timer_flush ()</h3>
<pre class="programlisting">void prelude_timer_flush (void);</pre>
<p>
Expire every timer.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="prelude-timer-lock-critical-region"></a><h3>prelude_timer_lock_critical_region ()</h3>
<pre class="programlisting">void prelude_timer_lock_critical_region (void);</pre>
<p>
Deactivate timer wake-up until <code class="function">timer_unlock_critical_region()</code> is called.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="prelude-timer-unlock-critical-region"></a><h3>prelude_timer_unlock_critical_region ()</h3>
<pre class="programlisting">void prelude_timer_unlock_critical_region
(void);</pre>
<p>
Reactivate timer wake-up after <code class="function">timer_lock_critical_regions()</code> has been called.</p>
<p>
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.10</div>
</body>
</html>
|