Debian Codegraph @

docs/api/html/libprelude-prelude-client.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>prelude-client: libprelude Reference Manual</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7 <link rel="home" href="index.html" title="libprelude Reference Manual">
8 <link rel="up" href="ch01.html" title="[Insert title here]">
9 <link rel="prev" href="libprelude-prelude-ident.html" title="prelude-ident">
10 <link rel="next" href="libprelude-prelude-client-profile.html" title="prelude-client-profile">
11 <meta name="generator" content="GTK-Doc V1.28 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16 <td width="100%" align="left" class="shortcuts">
17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
18 <a href="#libprelude-prelude-client.description" class="shortcut">Description</a></span>
19 </td>
20 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
21 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
22 <td><a accesskey="p" href="libprelude-prelude-ident.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
23 <td><a accesskey="n" href="libprelude-prelude-client-profile.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
24 </tr></table>
25 <div class="refentry">
26 <a name="libprelude-prelude-client"></a><div class="titlepage"></div>
27 <div class="refnamediv"><table width="100%"><tr>
28 <td valign="top">
29 <h2><span class="refentrytitle"><a name="libprelude-prelude-client.top_of_page"></a>prelude-client</span></h2>
30 <p>prelude-client</p>
31 </td>
32 <td class="gallery_image" valign="top" align="right"></td>
33 </tr></table></div>
34 <div class="refsect1">
35 <a name="libprelude-prelude-client.functions"></a><h2>Functions</h2>
36 <div class="informaltable"><table width="100%" border="0">
37 <colgroup>
38 <col width="150px" class="functions_return">
39 <col class="functions_name">
40 </colgroup>
41 <tbody>
42 <tr>
43 <td class="function_type">
44 <a class="link" href="libprelude-prelude-ident.html#prelude-ident-t" title="prelude_ident_t"><span class="returnvalue">prelude_ident_t</span></a> *
45 </td>
46 <td class="function_name">
47 <a class="link" href="libprelude-prelude-client.html#prelude-client-get-unique-ident" title="prelude_client_get_unique_ident ()">prelude_client_get_unique_ident</a> <span class="c_punctuation">()</span>
48 </td>
49 </tr>
50 <tr>
51 <td class="function_type">
52 <span class="returnvalue">void</span>
53 </td>
54 <td class="function_name">
55 <a class="link" href="libprelude-prelude-client.html#prelude-client-set-connection-pool" title="prelude_client_set_connection_pool ()">prelude_client_set_connection_pool</a> <span class="c_punctuation">()</span>
56 </td>
57 </tr>
58 <tr>
59 <td class="function_type">
60 <a class="link" href="libprelude-prelude-connection-pool.html#prelude-connection-pool-t" title="prelude_connection_pool_t"><span class="returnvalue">prelude_connection_pool_t</span></a> *
61 </td>
62 <td class="function_name">
63 <a class="link" href="libprelude-prelude-client.html#prelude-client-get-connection-pool" title="prelude_client_get_connection_pool ()">prelude_client_get_connection_pool</a> <span class="c_punctuation">()</span>
64 </td>
65 </tr>
66 <tr>
67 <td class="function_type">
68 <span class="returnvalue">int</span>
69 </td>
70 <td class="function_name">
71 <a class="link" href="libprelude-prelude-client.html#prelude-client-start" title="prelude_client_start ()">prelude_client_start</a> <span class="c_punctuation">()</span>
72 </td>
73 </tr>
74 <tr>
75 <td class="function_type">
76 <span class="returnvalue">int</span>
77 </td>
78 <td class="function_name">
79 <a class="link" href="libprelude-prelude-client.html#prelude-client-init" title="prelude_client_init ()">prelude_client_init</a> <span class="c_punctuation">()</span>
80 </td>
81 </tr>
82 <tr>
83 <td class="function_type">
84 <span class="returnvalue">int</span>
85 </td>
86 <td class="function_name">
87 <a class="link" href="libprelude-prelude-client.html#prelude-client-new" title="prelude_client_new ()">prelude_client_new</a> <span class="c_punctuation">()</span>
88 </td>
89 </tr>
90 <tr>
91 <td class="function_type">
92 <a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="returnvalue">prelude_client_t</span></a> *
93 </td>
94 <td class="function_name">
95 <a class="link" href="libprelude-prelude-client.html#prelude-client-ref" title="prelude_client_ref ()">prelude_client_ref</a> <span class="c_punctuation">()</span>
96 </td>
97 </tr>
98 <tr>
99 <td class="function_type">
100 <a class="link" href="libprelude-idmef-tree-wrap.html#idmef-analyzer-t" title="idmef_analyzer_t"><span class="returnvalue">idmef_analyzer_t</span></a> *
101 </td>
102 <td class="function_name">
103 <a class="link" href="libprelude-prelude-client.html#prelude-client-get-analyzer" title="prelude_client_get_analyzer ()">prelude_client_get_analyzer</a> <span class="c_punctuation">()</span>
104 </td>
105 </tr>
106 <tr>
107 <td class="function_type">
108 <a class="link" href="libprelude-prelude-client.html#prelude-client-flags-t" title="enum prelude_client_flags_t"><span class="returnvalue">prelude_client_flags_t</span></a>
109 </td>
110 <td class="function_name">
111 <a class="link" href="libprelude-prelude-client.html#prelude-client-get-flags" title="prelude_client_get_flags ()">prelude_client_get_flags</a> <span class="c_punctuation">()</span>
112 </td>
113 </tr>
114 <tr>
115 <td class="function_type">
116 <span class="returnvalue">void</span>
117 </td>
118 <td class="function_name">
119 <a class="link" href="libprelude-prelude-client.html#prelude-client-set-required-permission" title="prelude_client_set_required_permission ()">prelude_client_set_required_permission</a> <span class="c_punctuation">()</span>
120 </td>
121 </tr>
122 <tr>
123 <td class="function_type">
124 <a class="link" href="libprelude-prelude-connection.html#prelude-connection-permission-t" title="enum prelude_connection_permission_t"><span class="returnvalue">prelude_connection_permission_t</span></a>
125 </td>
126 <td class="function_name">
127 <a class="link" href="libprelude-prelude-client.html#prelude-client-get-required-permission" title="prelude_client_get_required_permission ()">prelude_client_get_required_permission</a> <span class="c_punctuation">()</span>
128 </td>
129 </tr>
130 <tr>
131 <td class="function_type">
132 <span class="returnvalue">void</span>
133 </td>
134 <td class="function_name">
135 <a class="link" href="libprelude-prelude-client.html#prelude-client-send-msg" title="prelude_client_send_msg ()">prelude_client_send_msg</a> <span class="c_punctuation">()</span>
136 </td>
137 </tr>
138 <tr>
139 <td class="function_type">
140 <span class="returnvalue">int</span>
141 </td>
142 <td class="function_name">
143 <a class="link" href="libprelude-prelude-client.html#prelude-client-recv-msg" title="prelude_client_recv_msg ()">prelude_client_recv_msg</a> <span class="c_punctuation">()</span>
144 </td>
145 </tr>
146 <tr>
147 <td class="function_type">
148 <span class="returnvalue">void</span>
149 </td>
150 <td class="function_name">
151 <a class="link" href="libprelude-prelude-client.html#prelude-client-set-heartbeat-cb" title="prelude_client_set_heartbeat_cb ()">prelude_client_set_heartbeat_cb</a> <span class="c_punctuation">()</span>
152 </td>
153 </tr>
154 <tr>
155 <td class="function_type">
156 <span class="returnvalue">void</span>
157 </td>
158 <td class="function_name">
159 <a class="link" href="libprelude-prelude-client.html#prelude-client-send-idmef" title="prelude_client_send_idmef ()">prelude_client_send_idmef</a> <span class="c_punctuation">()</span>
160 </td>
161 </tr>
162 <tr>
163 <td class="function_type">
164 <span class="returnvalue">int</span>
165 </td>
166 <td class="function_name">
167 <a class="link" href="libprelude-prelude-client.html#prelude-client-recv-idmef" title="prelude_client_recv_idmef ()">prelude_client_recv_idmef</a> <span class="c_punctuation">()</span>
168 </td>
169 </tr>
170 <tr>
171 <td class="function_type">
172 <span class="returnvalue">void</span>
173 </td>
174 <td class="function_name">
175 <a class="link" href="libprelude-prelude-client.html#prelude-client-destroy" title="prelude_client_destroy ()">prelude_client_destroy</a> <span class="c_punctuation">()</span>
176 </td>
177 </tr>
178 <tr>
179 <td class="function_type">
180 <span class="returnvalue">int</span>
181 </td>
182 <td class="function_name">
183 <a class="link" href="libprelude-prelude-client.html#prelude-client-set-flags" title="prelude_client_set_flags ()">prelude_client_set_flags</a> <span class="c_punctuation">()</span>
184 </td>
185 </tr>
186 <tr>
187 <td class="function_type">
188 <span class="returnvalue">int</span>
189 </td>
190 <td class="function_name">
191 <a class="link" href="libprelude-prelude-client.html#prelude-client-set-config-filename" title="prelude_client_set_config_filename ()">prelude_client_set_config_filename</a> <span class="c_punctuation">()</span>
192 </td>
193 </tr>
194 <tr>
195 <td class="function_type">const <span class="returnvalue">char</span> *
196 </td>
197 <td class="function_name">
198 <a class="link" href="libprelude-prelude-client.html#prelude-client-get-config-filename" title="prelude_client_get_config_filename ()">prelude_client_get_config_filename</a> <span class="c_punctuation">()</span>
199 </td>
200 </tr>
201 <tr>
202 <td class="function_type">
203 <a class="link" href="libprelude-prelude-inttypes.html#prelude-bool-t" title="enum prelude_bool_t"><span class="returnvalue">prelude_bool_t</span></a>
204 </td>
205 <td class="function_name">
206 <a class="link" href="libprelude-prelude-client.html#prelude-client-is-setup-needed" title="prelude_client_is_setup_needed ()">prelude_client_is_setup_needed</a> <span class="c_punctuation">()</span>
207 </td>
208 </tr>
209 <tr>
210 <td class="function_type">
211 <a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="returnvalue">prelude_client_profile_t</span></a> *
212 </td>
213 <td class="function_name">
214 <a class="link" href="libprelude-prelude-client.html#prelude-client-get-profile" title="prelude_client_get_profile ()">prelude_client_get_profile</a> <span class="c_punctuation">()</span>
215 </td>
216 </tr>
217 <tr>
218 <td class="function_type">
219 <span class="returnvalue">int</span>
220 </td>
221 <td class="function_name">
222 <a class="link" href="libprelude-prelude-client.html#prelude-client-new-msgbuf" title="prelude_client_new_msgbuf ()">prelude_client_new_msgbuf</a> <span class="c_punctuation">()</span>
223 </td>
224 </tr>
225 <tr>
226 <td class="function_type">
227 <span class="returnvalue">int</span>
228 </td>
229 <td class="function_name">
230 <a class="link" href="libprelude-prelude-client.html#prelude-client-handle-msg-default" title="prelude_client_handle_msg_default ()">prelude_client_handle_msg_default</a> <span class="c_punctuation">()</span>
231 </td>
232 </tr>
233 <tr>
234 <td class="function_type">const <span class="returnvalue">char</span> *
235 </td>
236 <td class="function_name">
237 <a class="link" href="libprelude-prelude-client.html#prelude-client-get-setup-error" title="prelude_client_get_setup_error ()">prelude_client_get_setup_error</a> <span class="c_punctuation">()</span>
238 </td>
239 </tr>
240 <tr>
241 <td class="function_type">
242 <span class="returnvalue">void</span>
243 </td>
244 <td class="function_name">
245 <a class="link" href="libprelude-prelude-client.html#prelude-client-print-setup-error" title="prelude_client_print_setup_error ()">prelude_client_print_setup_error</a> <span class="c_punctuation">()</span>
246 </td>
247 </tr>
248 </tbody>
249 </table></div>
250 </div>
251 <div class="refsect1">
252 <a name="libprelude-prelude-client.other"></a><h2>Types and Values</h2>
253 <div class="informaltable"><table width="100%" border="0">
254 <colgroup>
255 <col width="150px" class="name">
256 <col class="description">
257 </colgroup>
258 <tbody>
259 <tr>
260 <td class="datatype_keyword">enum</td>
261 <td class="function_name"><a class="link" href="libprelude-prelude-client.html#prelude-client-exit-status-t" title="enum prelude_client_exit_status_t">prelude_client_exit_status_t</a></td>
262 </tr>
263 <tr>
264 <td class="datatype_keyword">enum</td>
265 <td class="function_name"><a class="link" href="libprelude-prelude-client.html#prelude-client-flags-t" title="enum prelude_client_flags_t">prelude_client_flags_t</a></td>
266 </tr>
267 <tr>
268 <td class="typedef_keyword">typedef</td>
269 <td class="function_name"><a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t">prelude_client_t</a></td>
270 </tr>
271 </tbody>
272 </table></div>
273 </div>
274 <div class="refsect1">
275 <a name="libprelude-prelude-client.description"></a><h2>Description</h2>
276 </div>
277 <div class="refsect1">
278 <a name="libprelude-prelude-client.functions_details"></a><h2>Functions</h2>
279 <div class="refsect2">
280 <a name="prelude-client-get-unique-ident"></a><h3>prelude_client_get_unique_ident ()</h3>
281 <pre class="programlisting"><a class="link" href="libprelude-prelude-ident.html#prelude-ident-t" title="prelude_ident_t"><span class="returnvalue">prelude_ident_t</span></a> *
282 prelude_client_get_unique_ident (<em class="parameter"><code><a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> *client</code></em>);</pre>
283 </div>
284 <hr>
285 <div class="refsect2">
286 <a name="prelude-client-set-connection-pool"></a><h3>prelude_client_set_connection_pool ()</h3>
287 <pre class="programlisting"><span class="returnvalue">void</span>
288 prelude_client_set_connection_pool (<em class="parameter"><code><a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> *client</code></em>,
289 <em class="parameter"><code><a class="link" href="libprelude-prelude-connection-pool.html#prelude-connection-pool-t" title="prelude_connection_pool_t"><span class="type">prelude_connection_pool_t</span></a> *pool</code></em>);</pre>
290 <p>Use this function in order to set your own list of peer that <em class="parameter"><code>client</code></em>
291
292 should send message too. This might be usefull in case you don't want
293 this to be automated by <a class="link" href="libprelude-prelude-client.html#prelude-client-init" title="prelude_client_init ()"><code class="function">prelude_client_init()</code></a>.</p>
294 <div class="refsect3">
295 <a name="prelude-client-set-connection-pool.parameters"></a><h4>Parameters</h4>
296 <div class="informaltable"><table width="100%" border="0">
297 <colgroup>
298 <col width="150px" class="parameters_name">
299 <col class="parameters_description">
300 <col width="200px" class="parameters_annotations">
301 </colgroup>
302 <tbody>
303 <tr>
304 <td class="parameter_name"><p>client</p></td>
305 <td class="parameter_description"><p>pointer to a <a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> object.</p></td>
306 <td class="parameter_annotations"> </td>
307 </tr>
308 <tr>
309 <td class="parameter_name"><p>pool</p></td>
310 <td class="parameter_description"><p>pointer to a <span class="type">prelude_client_pool_t</span> object.</p></td>
311 <td class="parameter_annotations"> </td>
312 </tr>
313 </tbody>
314 </table></div>
315 </div>
316 </div>
317 <hr>
318 <div class="refsect2">
319 <a name="prelude-client-get-connection-pool"></a><h3>prelude_client_get_connection_pool ()</h3>
320 <pre class="programlisting"><a class="link" href="libprelude-prelude-connection-pool.html#prelude-connection-pool-t" title="prelude_connection_pool_t"><span class="returnvalue">prelude_connection_pool_t</span></a> *
321 prelude_client_get_connection_pool (<em class="parameter"><code><a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> *client</code></em>);</pre>
322 <p>Return a pointer to the <a class="link" href="libprelude-prelude-connection-pool.html#prelude-connection-pool-t" title="prelude_connection_pool_t"><span class="type">prelude_connection_pool_t</span></a> object used by <em class="parameter"><code>client</code></em>
323
324 to send messages.</p>
325 <div class="refsect3">
326 <a name="prelude-client-get-connection-pool.parameters"></a><h4>Parameters</h4>
327 <div class="informaltable"><table width="100%" border="0">
328 <colgroup>
329 <col width="150px" class="parameters_name">
330 <col class="parameters_description">
331 <col width="200px" class="parameters_annotations">
332 </colgroup>
333 <tbody><tr>
334 <td class="parameter_name"><p>client</p></td>
335 <td class="parameter_description"><p>pointer to a <a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> object.</p></td>
336 <td class="parameter_annotations"> </td>
337 </tr></tbody>
338 </table></div>
339 </div>
340 <div class="refsect3">
341 <a name="prelude-client-get-connection-pool.returns"></a><h4>Returns</h4>
342 <p> a pointer to a <a class="link" href="libprelude-prelude-connection-pool.html#prelude-connection-pool-t" title="prelude_connection_pool_t"><span class="type">prelude_connection_pool_t</span></a> object.</p>
343 </div>
344 </div>
345 <hr>
346 <div class="refsect2">
347 <a name="prelude-client-start"></a><h3>prelude_client_start ()</h3>
348 <pre class="programlisting"><span class="returnvalue">int</span>
349 prelude_client_start (<em class="parameter"><code><a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> *client</code></em>);</pre>
350 <p>This function start the <em class="parameter"><code>client</code></em>
351 object, triggering
352 a connection from the client to it's server if any were
353 specified, and sending the initial <em class="parameter"><code>client</code></em>
354 heartbeat.</p>
355 <p>If <em class="parameter"><code>client</code></em>
356 was not initialized, then <a class="link" href="libprelude-prelude-client.html#prelude-client-init" title="prelude_client_init ()"><code class="function">prelude_client_init()</code></a>
357 will be called and thus this function might fail if the
358 client was not registered.</p>
359 <div class="refsect3">
360 <a name="prelude-client-start.parameters"></a><h4>Parameters</h4>
361 <div class="informaltable"><table width="100%" border="0">
362 <colgroup>
363 <col width="150px" class="parameters_name">
364 <col class="parameters_description">
365 <col width="200px" class="parameters_annotations">
366 </colgroup>
367 <tbody><tr>
368 <td class="parameter_name"><p>client</p></td>
369 <td class="parameter_description"><p>Pointer to a client object to initialize.</p></td>
370 <td class="parameter_annotations"> </td>
371 </tr></tbody>
372 </table></div>
373 </div>
374 <div class="refsect3">
375 <a name="prelude-client-start.returns"></a><h4>Returns</h4>
376 <p> 0 on success, -1 if an error occured.</p>
377 </div>
378 </div>
379 <hr>
380 <div class="refsect2">
381 <a name="prelude-client-init"></a><h3>prelude_client_init ()</h3>
382 <pre class="programlisting"><span class="returnvalue">int</span>
383 prelude_client_init (<em class="parameter"><code><a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> *client</code></em>);</pre>
384 <p>This function initialize the <em class="parameter"><code>client</code></em>
385 object, meaning reading generic
386 options from the <a class="link" href="libprelude-prelude-client.html#prelude-client-new" title="prelude_client_new ()"><code class="function">prelude_client_new()</code></a> provided configuration file
387 and the array of arguments specified through <a class="link" href="libprelude-prelude.html#prelude-init" title="prelude_init ()"><code class="function">prelude_init()</code></a>.</p>
388 <p>Calling this function is optional and should be done only if you need more
389 granularity between <a class="link" href="libprelude-prelude-client.html#prelude-client-new" title="prelude_client_new ()"><code class="function">prelude_client_new()</code></a> and <a class="link" href="libprelude-prelude-client.html#prelude-client-start" title="prelude_client_start ()"><code class="function">prelude_client_start()</code></a>:</p>
390 <p>prelude_client_start() will call <a class="link" href="libprelude-prelude-client.html#prelude-client-init" title="prelude_client_init ()"><code class="function">prelude_client_init()</code></a> for you if needed.</p>
391 <div class="refsect3">
392 <a name="prelude-client-init.parameters"></a><h4>Parameters</h4>
393 <div class="informaltable"><table width="100%" border="0">
394 <colgroup>
395 <col width="150px" class="parameters_name">
396 <col class="parameters_description">
397 <col width="200px" class="parameters_annotations">
398 </colgroup>
399 <tbody><tr>
400 <td class="parameter_name"><p>client</p></td>
401 <td class="parameter_description"><p>Pointer to a <a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> object to initialize.</p></td>
402 <td class="parameter_annotations"> </td>
403 </tr></tbody>
404 </table></div>
405 </div>
406 <div class="refsect3">
407 <a name="prelude-client-init.returns"></a><h4>Returns</h4>
408 <p> 0 on success, -1 if an error occured.</p>
409 </div>
410 </div>
411 <hr>
412 <div class="refsect2">
413 <a name="prelude-client-new"></a><h3>prelude_client_new ()</h3>
414 <pre class="programlisting"><span class="returnvalue">int</span>
415 prelude_client_new (<em class="parameter"><code><a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> **client</code></em>,
416 <em class="parameter"><code>const <span class="type">char</span> *profile</code></em>);</pre>
417 <p>This function initialize the <em class="parameter"><code>client</code></em>
418 object.</p>
419 <div class="refsect3">
420 <a name="prelude-client-new.parameters"></a><h4>Parameters</h4>
421 <div class="informaltable"><table width="100%" border="0">
422 <colgroup>
423 <col width="150px" class="parameters_name">
424 <col class="parameters_description">
425 <col width="200px" class="parameters_annotations">
426 </colgroup>
427 <tbody>
428 <tr>
429 <td class="parameter_name"><p>client</p></td>
430 <td class="parameter_description"><p>Pointer to a client object to initialize.</p></td>
431 <td class="parameter_annotations"> </td>
432 </tr>
433 <tr>
434 <td class="parameter_name"><p>profile</p></td>
435 <td class="parameter_description"><p>Default profile name for this analyzer.</p></td>
436 <td class="parameter_annotations"> </td>
437 </tr>
438 </tbody>
439 </table></div>
440 </div>
441 <div class="refsect3">
442 <a name="prelude-client-new.returns"></a><h4>Returns</h4>
443 <p> 0 on success or a negative value if an error occur.</p>
444 </div>
445 </div>
446 <hr>
447 <div class="refsect2">
448 <a name="prelude-client-ref"></a><h3>prelude_client_ref ()</h3>
449 <pre class="programlisting"><a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="returnvalue">prelude_client_t</span></a> *
450 prelude_client_ref (<em class="parameter"><code><a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> *client</code></em>);</pre>
451 </div>
452 <hr>
453 <div class="refsect2">
454 <a name="prelude-client-get-analyzer"></a><h3>prelude_client_get_analyzer ()</h3>
455 <pre class="programlisting"><a class="link" href="libprelude-idmef-tree-wrap.html#idmef-analyzer-t" title="idmef_analyzer_t"><span class="returnvalue">idmef_analyzer_t</span></a> *
456 prelude_client_get_analyzer (<em class="parameter"><code><a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> *client</code></em>);</pre>
457 <p>Provide access to the <a class="link" href="libprelude-idmef-tree-wrap.html#idmef-analyzer-t" title="idmef_analyzer_t"><span class="type">idmef_analyzer_t</span></a> object associated to <em class="parameter"><code>client</code></em>
458 .
459 This analyzer object is sent along with every alerts and heartbeats emited
460 by this client. The analyzer object is created by <a class="link" href="libprelude-prelude-client.html#prelude-client-init" title="prelude_client_init ()"><code class="function">prelude_client_init()</code></a>.</p>
461 <div class="refsect3">
462 <a name="prelude-client-get-analyzer.parameters"></a><h4>Parameters</h4>
463 <div class="informaltable"><table width="100%" border="0">
464 <colgroup>
465 <col width="150px" class="parameters_name">
466 <col class="parameters_description">
467 <col width="200px" class="parameters_annotations">
468 </colgroup>
469 <tbody><tr>
470 <td class="parameter_name"><p>client</p></td>
471 <td class="parameter_description"><p>Pointer to a <a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> object.</p></td>
472 <td class="parameter_annotations"> </td>
473 </tr></tbody>
474 </table></div>
475 </div>
476 <div class="refsect3">
477 <a name="prelude-client-get-analyzer.returns"></a><h4>Returns</h4>
478 <p> the <a class="link" href="libprelude-idmef-tree-wrap.html#idmef-analyzer-t" title="idmef_analyzer_t"><span class="type">idmef_analyzer_t</span></a> object associated with <em class="parameter"><code>client</code></em>
479 .</p>
480 </div>
481 </div>
482 <hr>
483 <div class="refsect2">
484 <a name="prelude-client-get-flags"></a><h3>prelude_client_get_flags ()</h3>
485 <pre class="programlisting"><a class="link" href="libprelude-prelude-client.html#prelude-client-flags-t" title="enum prelude_client_flags_t"><span class="returnvalue">prelude_client_flags_t</span></a>
486 prelude_client_get_flags (<em class="parameter"><code><a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> *client</code></em>);</pre>
487 <p>Get flags set through <a class="link" href="libprelude-prelude-client.html#prelude-client-set-flags" title="prelude_client_set_flags ()"><code class="function">prelude_client_set_flags()</code></a>.</p>
488 <div class="refsect3">
489 <a name="prelude-client-get-flags.parameters"></a><h4>Parameters</h4>
490 <div class="informaltable"><table width="100%" border="0">
491 <colgroup>
492 <col width="150px" class="parameters_name">
493 <col class="parameters_description">
494 <col width="200px" class="parameters_annotations">
495 </colgroup>
496 <tbody><tr>
497 <td class="parameter_name"><p>client</p></td>
498 <td class="parameter_description"><p>Pointer on a <a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> object.</p></td>
499 <td class="parameter_annotations"> </td>
500 </tr></tbody>
501 </table></div>
502 </div>
503 <div class="refsect3">
504 <a name="prelude-client-get-flags.returns"></a><h4>Returns</h4>
505 <p> an or'ed list of <a class="link" href="libprelude-prelude-client.html#prelude-client-flags-t" title="enum prelude_client_flags_t"><span class="type">prelude_client_flags_t</span></a>.</p>
506 </div>
507 </div>
508 <hr>
509 <div class="refsect2">
510 <a name="prelude-client-set-required-permission"></a><h3>prelude_client_set_required_permission ()</h3>
511 <pre class="programlisting"><span class="returnvalue">void</span>
512 prelude_client_set_required_permission
513 (<em class="parameter"><code><a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> *client</code></em>,
514 <em class="parameter"><code><a class="link" href="libprelude-prelude-connection.html#prelude-connection-permission-t" title="enum prelude_connection_permission_t"><span class="type">prelude_connection_permission_t</span></a> permission</code></em>);</pre>
515 <p>Set the required <em class="parameter"><code>permission</code></em>
516 for <em class="parameter"><code>client</code></em>
517 .
518 The default is <a class="link" href="libprelude-prelude-connection.html#PRELUDE-CONNECTION-PERMISSION-IDMEF-WRITE:CAPS"><span class="type">PRELUDE_CONNECTION_PERMISSION_IDMEF_WRITE</span></a> | <a class="link" href="libprelude-prelude-connection.html#PRELUDE-CONNECTION-PERMISSION-ADMIN-READ:CAPS"><span class="type">PRELUDE_CONNECTION_PERMISSION_ADMIN_READ</span></a>.
519 Value set through this function should be set before <a class="link" href="libprelude-prelude-client.html#prelude-client-start" title="prelude_client_start ()"><code class="function">prelude_client_start()</code></a>.</p>
520 <p>If the client certificate for connecting to one of the specified manager doesn't have theses permission
521 the client will reject the certificate and ask for registration.</p>
522 <div class="refsect3">
523 <a name="prelude-client-set-required-permission.parameters"></a><h4>Parameters</h4>
524 <div class="informaltable"><table width="100%" border="0">
525 <colgroup>
526 <col width="150px" class="parameters_name">
527 <col class="parameters_description">
528 <col width="200px" class="parameters_annotations">
529 </colgroup>
530 <tbody>
531 <tr>
532 <td class="parameter_name"><p>client</p></td>
533 <td class="parameter_description"><p>Pointer on a <a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> object.</p></td>
534 <td class="parameter_annotations"> </td>
535 </tr>
536 <tr>
537 <td class="parameter_name"><p>permission</p></td>
538 <td class="parameter_description"><p>Required permission for <em class="parameter"><code>client</code></em>
539 .</p></td>
540 <td class="parameter_annotations"> </td>
541 </tr>
542 </tbody>
543 </table></div>
544 </div>
545 </div>
546 <hr>
547 <div class="refsect2">
548 <a name="prelude-client-get-required-permission"></a><h3>prelude_client_get_required_permission ()</h3>
549 <pre class="programlisting"><a class="link" href="libprelude-prelude-connection.html#prelude-connection-permission-t" title="enum prelude_connection_permission_t"><span class="returnvalue">prelude_connection_permission_t</span></a>
550 prelude_client_get_required_permission
551 (<em class="parameter"><code><a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> *client</code></em>);</pre>
552 <div class="refsect3">
553 <a name="prelude-client-get-required-permission.parameters"></a><h4>Parameters</h4>
554 <div class="informaltable"><table width="100%" border="0">
555 <colgroup>
556 <col width="150px" class="parameters_name">
557 <col class="parameters_description">
558 <col width="200px" class="parameters_annotations">
559 </colgroup>
560 <tbody><tr>
561 <td class="parameter_name"><p>client</p></td>
562 <td class="parameter_description"><p>Pointer on a <a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> object.</p></td>
563 <td class="parameter_annotations"> </td>
564 </tr></tbody>
565 </table></div>
566 </div>
567 <div class="refsect3">
568 <a name="prelude-client-get-required-permission.returns"></a><h4>Returns</h4>
569 <p> <em class="parameter"><code>client</code></em>
570 permission as set with <a class="link" href="libprelude-prelude-client.html#prelude-client-set-required-permission" title="prelude_client_set_required_permission ()"><code class="function">prelude_client_set_required_permission()</code></a></p>
571 </div>
572 </div>
573 <hr>
574 <div class="refsect2">
575 <a name="prelude-client-send-msg"></a><h3>prelude_client_send_msg ()</h3>
576 <pre class="programlisting"><span class="returnvalue">void</span>
577 prelude_client_send_msg (<em class="parameter"><code><a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> *client</code></em>,
578 <em class="parameter"><code><a class="link" href="libprelude-prelude-msg.html#prelude-msg-t" title="prelude_msg_t"><span class="type">prelude_msg_t</span></a> *msg</code></em>);</pre>
579 <p>Send <em class="parameter"><code>msg</code></em>
580 to the peers <em class="parameter"><code>client</code></em>
581 is communicating with.</p>
582 <p>The message will be sent asynchronously if <em class="parameter"><code>PRELUDE_CLIENT_FLAGS_ASYNC_SEND</code></em>
583
584 was set using <a class="link" href="libprelude-prelude-client.html#prelude-client-set-flags" title="prelude_client_set_flags ()"><code class="function">prelude_client_set_flags()</code></a> in which case the caller should
585 not call <a class="link" href="libprelude-prelude-msg.html#prelude-msg-destroy" title="prelude_msg_destroy ()"><code class="function">prelude_msg_destroy()</code></a> on <em class="parameter"><code>msg</code></em>
586 .</p>
587 <div class="refsect3">
588 <a name="prelude-client-send-msg.parameters"></a><h4>Parameters</h4>
589 <div class="informaltable"><table width="100%" border="0">
590 <colgroup>
591 <col width="150px" class="parameters_name">
592 <col class="parameters_description">
593 <col width="200px" class="parameters_annotations">
594 </colgroup>
595 <tbody>
596 <tr>
597 <td class="parameter_name"><p>client</p></td>
598 <td class="parameter_description"><p>Pointer to a <a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> object.</p></td>
599 <td class="parameter_annotations"> </td>
600 </tr>
601 <tr>
602 <td class="parameter_name"><p>msg</p></td>
603 <td class="parameter_description"><p>pointer to a message that <em class="parameter"><code>client</code></em>
604 should send.</p></td>
605 <td class="parameter_annotations"> </td>
606 </tr>
607 </tbody>
608 </table></div>
609 </div>
610 </div>
611 <hr>
612 <div class="refsect2">
613 <a name="prelude-client-recv-msg"></a><h3>prelude_client_recv_msg ()</h3>
614 <pre class="programlisting"><span class="returnvalue">int</span>
615 prelude_client_recv_msg (<em class="parameter"><code><a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> *client</code></em>,
616 <em class="parameter"><code><span class="type">int</span> timeout</code></em>,
617 <em class="parameter"><code><a class="link" href="libprelude-prelude-msg.html#prelude-msg-t" title="prelude_msg_t"><span class="type">prelude_msg_t</span></a> **msg</code></em>);</pre>
618 <p>Wait <em class="parameter"><code>timeout</code></em>
619 second for a message on <em class="parameter"><code>client</code></em>
620 connection pool.</p>
621 <p>A <em class="parameter"><code>timeout</code></em>
622 of -1, mean <a class="link" href="libprelude-prelude-client.html#prelude-client-recv-msg" title="prelude_client_recv_msg ()"><code class="function">prelude_client_recv_msg()</code></a> will block until
623 a message is received. A <em class="parameter"><code>timeout</code></em>
624 of 0 mean that it will return
625 immediatly.</p>
626 <div class="refsect3">
627 <a name="prelude-client-recv-msg.parameters"></a><h4>Parameters</h4>
628 <div class="informaltable"><table width="100%" border="0">
629 <colgroup>
630 <col width="150px" class="parameters_name">
631 <col class="parameters_description">
632 <col width="200px" class="parameters_annotations">
633 </colgroup>
634 <tbody>
635 <tr>
636 <td class="parameter_name"><p>client</p></td>
637 <td class="parameter_description"><p>Pointer to a <a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> object.</p></td>
638 <td class="parameter_annotations"> </td>
639 </tr>
640 <tr>
641 <td class="parameter_name"><p>timeout</p></td>
642 <td class="parameter_description"><p>Number of millisecond to wait for a message.</p></td>
643 <td class="parameter_annotations"> </td>
644 </tr>
645 <tr>
646 <td class="parameter_name"><p>msg</p></td>
647 <td class="parameter_description"><p>Pointer where the received <a class="link" href="libprelude-prelude-msg.html#prelude-msg-t" title="prelude_msg_t"><span class="type">prelude_msg_t</span></a> should be stored.</p></td>
648 <td class="parameter_annotations"> </td>
649 </tr>
650 </tbody>
651 </table></div>
652 </div>
653 <div class="refsect3">
654 <a name="prelude-client-recv-msg.returns"></a><h4>Returns</h4>
655 <p> 0 on timeout, a negative value on error, 1 on success.</p>
656 </div>
657 </div>
658 <hr>
659 <div class="refsect2">
660 <a name="prelude-client-set-heartbeat-cb"></a><h3>prelude_client_set_heartbeat_cb ()</h3>
661 <pre class="programlisting"><span class="returnvalue">void</span>
662 prelude_client_set_heartbeat_cb (<em class="parameter"><code><a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> *client</code></em>,
663 <em class="parameter"><code><span class="type">void</span> (*cb) (prelude_client_t *client, idmef_message_t *hb)</code></em>);</pre>
664 <p>Use if you want to override the default function used to
665 automatically send heartbeat to <em class="parameter"><code>client</code></em>
666 peers.</p>
667 <div class="refsect3">
668 <a name="prelude-client-set-heartbeat-cb.parameters"></a><h4>Parameters</h4>
669 <div class="informaltable"><table width="100%" border="0">
670 <colgroup>
671 <col width="150px" class="parameters_name">
672 <col class="parameters_description">
673 <col width="200px" class="parameters_annotations">
674 </colgroup>
675 <tbody>
676 <tr>
677 <td class="parameter_name"><p>client</p></td>
678 <td class="parameter_description"><p>pointer to a <a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> object.</p></td>
679 <td class="parameter_annotations"> </td>
680 </tr>
681 <tr>
682 <td class="parameter_name"><p>cb</p></td>
683 <td class="parameter_description"><p>pointer to a function handling heartbeat sending.</p></td>
684 <td class="parameter_annotations"> </td>
685 </tr>
686 </tbody>
687 </table></div>
688 </div>
689 </div>
690 <hr>
691 <div class="refsect2">
692 <a name="prelude-client-send-idmef"></a><h3>prelude_client_send_idmef ()</h3>
693 <pre class="programlisting"><span class="returnvalue">void</span>
694 prelude_client_send_idmef (<em class="parameter"><code><a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> *client</code></em>,
695 <em class="parameter"><code><a class="link" href="libprelude-idmef-tree-wrap.html#idmef-message-t" title="idmef_message_t"><span class="type">idmef_message_t</span></a> *msg</code></em>);</pre>
696 <p>Send <em class="parameter"><code>msg</code></em>
697 to the peers <em class="parameter"><code>client</code></em>
698 is communicating with.</p>
699 <p>The message will be sent asynchronously if <em class="parameter"><code>PRELUDE_CLIENT_FLAGS_ASYNC_SEND</code></em>
700
701 was set using <a class="link" href="libprelude-prelude-client.html#prelude-client-set-flags" title="prelude_client_set_flags ()"><code class="function">prelude_client_set_flags()</code></a>.</p>
702 <div class="refsect3">
703 <a name="prelude-client-send-idmef.parameters"></a><h4>Parameters</h4>
704 <div class="informaltable"><table width="100%" border="0">
705 <colgroup>
706 <col width="150px" class="parameters_name">
707 <col class="parameters_description">
708 <col width="200px" class="parameters_annotations">
709 </colgroup>
710 <tbody>
711 <tr>
712 <td class="parameter_name"><p>client</p></td>
713 <td class="parameter_description"><p>Pointer to a <a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> object.</p></td>
714 <td class="parameter_annotations"> </td>
715 </tr>
716 <tr>
717 <td class="parameter_name"><p>msg</p></td>
718 <td class="parameter_description"><p>pointer to an IDMEF message to be sent to <em class="parameter"><code>client</code></em>
719 peers.</p></td>
720 <td class="parameter_annotations"> </td>
721 </tr>
722 </tbody>
723 </table></div>
724 </div>
725 </div>
726 <hr>
727 <div class="refsect2">
728 <a name="prelude-client-recv-idmef"></a><h3>prelude_client_recv_idmef ()</h3>
729 <pre class="programlisting"><span class="returnvalue">int</span>
730 prelude_client_recv_idmef (<em class="parameter"><code><a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> *client</code></em>,
731 <em class="parameter"><code><span class="type">int</span> timeout</code></em>,
732 <em class="parameter"><code><a class="link" href="libprelude-idmef-tree-wrap.html#idmef-message-t" title="idmef_message_t"><span class="type">idmef_message_t</span></a> **idmef</code></em>);</pre>
733 <p>Wait <em class="parameter"><code>timeout</code></em>
734 second for a message on <em class="parameter"><code>client</code></em>
735 connection pool.</p>
736 <p>A <em class="parameter"><code>timeout</code></em>
737 of -1, mean <a class="link" href="libprelude-prelude-client.html#prelude-client-recv-idmef" title="prelude_client_recv_idmef ()"><code class="function">prelude_client_recv_idmef()</code></a> will block until
738 a message is received. A <em class="parameter"><code>timeout</code></em>
739 of 0 mean that it will return
740 immediatly.</p>
741 <div class="refsect3">
742 <a name="prelude-client-recv-idmef.parameters"></a><h4>Parameters</h4>
743 <div class="informaltable"><table width="100%" border="0">
744 <colgroup>
745 <col width="150px" class="parameters_name">
746 <col class="parameters_description">
747 <col width="200px" class="parameters_annotations">
748 </colgroup>
749 <tbody>
750 <tr>
751 <td class="parameter_name"><p>client</p></td>
752 <td class="parameter_description"><p>Pointer to a <a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> object.</p></td>
753 <td class="parameter_annotations"> </td>
754 </tr>
755 <tr>
756 <td class="parameter_name"><p>timeout</p></td>
757 <td class="parameter_description"><p>Number of second to wait for a message.</p></td>
758 <td class="parameter_annotations"> </td>
759 </tr>
760 <tr>
761 <td class="parameter_name"><p>idmef</p></td>
762 <td class="parameter_description"><p>Pointer where the received <a class="link" href="libprelude-idmef-tree-wrap.html#idmef-message-t" title="idmef_message_t"><span class="type">idmef_message_t</span></a> should be stored.</p></td>
763 <td class="parameter_annotations"> </td>
764 </tr>
765 </tbody>
766 </table></div>
767 </div>
768 <div class="refsect3">
769 <a name="prelude-client-recv-idmef.returns"></a><h4>Returns</h4>
770 <p> 0 on timeout, a negative value on error, 1 on success.</p>
771 </div>
772 </div>
773 <hr>
774 <div class="refsect2">
775 <a name="prelude-client-destroy"></a><h3>prelude_client_destroy ()</h3>
776 <pre class="programlisting"><span class="returnvalue">void</span>
777 prelude_client_destroy (<em class="parameter"><code><a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> *client</code></em>,
778 <em class="parameter"><code><a class="link" href="libprelude-prelude-client.html#prelude-client-exit-status-t" title="enum prelude_client_exit_status_t"><span class="type">prelude_client_exit_status_t</span></a> status</code></em>);</pre>
779 <p>Destroy <em class="parameter"><code>client</code></em>
780 , and send an heartbeat containing the 'exiting'
781 status in case <em class="parameter"><code>status</code></em>
782 is PRELUDE_CLIENT_EXIT_STATUS_SUCCESS.</p>
783 <p>This is useful for analyzer expected to be running periodically,
784 and that shouldn't be treated as behaving anormaly in case no
785 heartbeat is sent.</p>
786 <p>Please note that your are not supposed to run this function
787 from a signal handler.</p>
788 <div class="refsect3">
789 <a name="prelude-client-destroy.parameters"></a><h4>Parameters</h4>
790 <div class="informaltable"><table width="100%" border="0">
791 <colgroup>
792 <col width="150px" class="parameters_name">
793 <col class="parameters_description">
794 <col width="200px" class="parameters_annotations">
795 </colgroup>
796 <tbody>
797 <tr>
798 <td class="parameter_name"><p>client</p></td>
799 <td class="parameter_description"><p>Pointer on a client object.</p></td>
800 <td class="parameter_annotations"> </td>
801 </tr>
802 <tr>
803 <td class="parameter_name"><p>status</p></td>
804 <td class="parameter_description"><p>Exit status for the client.</p></td>
805 <td class="parameter_annotations"> </td>
806 </tr>
807 </tbody>
808 </table></div>
809 </div>
810 </div>
811 <hr>
812 <div class="refsect2">
813 <a name="prelude-client-set-flags"></a><h3>prelude_client_set_flags ()</h3>
814 <pre class="programlisting"><span class="returnvalue">int</span>
815 prelude_client_set_flags (<em class="parameter"><code><a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> *client</code></em>,
816 <em class="parameter"><code><a class="link" href="libprelude-prelude-client.html#prelude-client-flags-t" title="enum prelude_client_flags_t"><span class="type">prelude_client_flags_t</span></a> flags</code></em>);</pre>
817 <p>Set specific flags in the <em class="parameter"><code>client</code></em>
818 structure.
819 This function can be called anytime after the creation of the
820 <em class="parameter"><code>client</code></em>
821 object.</p>
822 <p>When settings asynchronous flags such as <a class="link" href="libprelude-prelude-client.html#PRELUDE-CLIENT-FLAGS-ASYNC-SEND:CAPS"><span class="type">PRELUDE_CLIENT_FLAGS_ASYNC_SEND</span></a>
823 or <a class="link" href="libprelude-prelude-client.html#PRELUDE-CLIENT-FLAGS-ASYNC-TIMER:CAPS"><span class="type">PRELUDE_CLIENT_FLAGS_ASYNC_TIMER</span></a>, be carefull to call
824 <a class="link" href="libprelude-prelude-client.html#prelude-client-set-flags" title="prelude_client_set_flags ()"><code class="function">prelude_client_set_flags()</code></a> in the same process you want to use the
825 asynchronous API from. Threads aren't copied accross <code class="function">fork()</code>.</p>
826 <div class="refsect3">
827 <a name="prelude-client-set-flags.parameters"></a><h4>Parameters</h4>
828 <div class="informaltable"><table width="100%" border="0">
829 <colgroup>
830 <col width="150px" class="parameters_name">
831 <col class="parameters_description">
832 <col width="200px" class="parameters_annotations">
833 </colgroup>
834 <tbody>
835 <tr>
836 <td class="parameter_name"><p>client</p></td>
837 <td class="parameter_description"><p>Pointer on a <a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> object.</p></td>
838 <td class="parameter_annotations"> </td>
839 </tr>
840 <tr>
841 <td class="parameter_name"><p>flags</p></td>
842 <td class="parameter_description"><p>Or'd list of flags used by <em class="parameter"><code>client</code></em>
843 .</p></td>
844 <td class="parameter_annotations"> </td>
845 </tr>
846 </tbody>
847 </table></div>
848 </div>
849 <div class="refsect3">
850 <a name="prelude-client-set-flags.returns"></a><h4>Returns</h4>
851 <p> 0 if setting <em class="parameter"><code>flags</code></em>
852 succeed, -1 otherwise.</p>
853 </div>
854 </div>
855 <hr>
856 <div class="refsect2">
857 <a name="prelude-client-set-config-filename"></a><h3>prelude_client_set_config_filename ()</h3>
858 <pre class="programlisting"><span class="returnvalue">int</span>
859 prelude_client_set_config_filename (<em class="parameter"><code><a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> *client</code></em>,
860 <em class="parameter"><code>const <span class="type">char</span> *filename</code></em>);</pre>
861 <p>The default for a client is to use a template configuration file (idmef-client.conf).
862 By using this function you might override the default and provide your own
863 configuration file to use for <em class="parameter"><code>client</code></em>
864 . The format of the configuration file need
865 to be compatible with the Prelude format.</p>
866 <div class="refsect3">
867 <a name="prelude-client-set-config-filename.parameters"></a><h4>Parameters</h4>
868 <div class="informaltable"><table width="100%" border="0">
869 <colgroup>
870 <col width="150px" class="parameters_name">
871 <col class="parameters_description">
872 <col width="200px" class="parameters_annotations">
873 </colgroup>
874 <tbody>
875 <tr>
876 <td class="parameter_name"><p>client</p></td>
877 <td class="parameter_description"><p>pointer on a <a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> object.</p></td>
878 <td class="parameter_annotations"> </td>
879 </tr>
880 <tr>
881 <td class="parameter_name"><p>filename</p></td>
882 <td class="parameter_description"><p>Configuration file to use for this client.</p></td>
883 <td class="parameter_annotations"> </td>
884 </tr>
885 </tbody>
886 </table></div>
887 </div>
888 <div class="refsect3">
889 <a name="prelude-client-set-config-filename.returns"></a><h4>Returns</h4>
890 <p> 0 on success, -1 if an error occured.</p>
891 </div>
892 </div>
893 <hr>
894 <div class="refsect2">
895 <a name="prelude-client-get-config-filename"></a><h3>prelude_client_get_config_filename ()</h3>
896 <pre class="programlisting">const <span class="returnvalue">char</span> *
897 prelude_client_get_config_filename (<em class="parameter"><code><a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> *client</code></em>);</pre>
898 <p>Return the filename where <em class="parameter"><code>client</code></em>
899 configuration is stored.
900 This filename is originally set by the <a class="link" href="libprelude-prelude-client.html#prelude-client-new" title="prelude_client_new ()"><code class="function">prelude_client_new()</code></a> function.</p>
901 <div class="refsect3">
902 <a name="prelude-client-get-config-filename.parameters"></a><h4>Parameters</h4>
903 <div class="informaltable"><table width="100%" border="0">
904 <colgroup>
905 <col width="150px" class="parameters_name">
906 <col class="parameters_description">
907 <col width="200px" class="parameters_annotations">
908 </colgroup>
909 <tbody><tr>
910 <td class="parameter_name"><p>client</p></td>
911 <td class="parameter_description"><p>pointer on a <a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> object.</p></td>
912 <td class="parameter_annotations"> </td>
913 </tr></tbody>
914 </table></div>
915 </div>
916 <div class="refsect3">
917 <a name="prelude-client-get-config-filename.returns"></a><h4>Returns</h4>
918 <p> a pointer to <em class="parameter"><code>client</code></em>
919 configuration filename.</p>
920 </div>
921 </div>
922 <hr>
923 <div class="refsect2">
924 <a name="prelude-client-is-setup-needed"></a><h3>prelude_client_is_setup_needed ()</h3>
925 <pre class="programlisting"><a class="link" href="libprelude-prelude-inttypes.html#prelude-bool-t" title="enum prelude_bool_t"><span class="returnvalue">prelude_bool_t</span></a>
926 prelude_client_is_setup_needed (<em class="parameter"><code><span class="type">int</span> error</code></em>);</pre>
927 <div class="warning">
928 <p><code class="literal">prelude_client_is_setup_needed</code> is deprecated and should not be used in newly-written code.</p>
929 <p>use standard error API.</p>
930 </div>
931 <p>This function should be called as a result of an error by
932 the <a class="link" href="libprelude-prelude-client.html#prelude-client-start" title="prelude_client_start ()"><code class="function">prelude_client_start()</code></a> function, to know if the analyzer
933 need to be registered.</p>
934 <div class="refsect3">
935 <a name="prelude-client-is-setup-needed.parameters"></a><h4>Parameters</h4>
936 <div class="informaltable"><table width="100%" border="0">
937 <colgroup>
938 <col width="150px" class="parameters_name">
939 <col class="parameters_description">
940 <col width="200px" class="parameters_annotations">
941 </colgroup>
942 <tbody><tr>
943 <td class="parameter_name"><p>error</p></td>
944 <td class="parameter_description"><p>Error returned by <a class="link" href="libprelude-prelude-client.html#prelude-client-start" title="prelude_client_start ()"><code class="function">prelude_client_start()</code></a>.</p></td>
945 <td class="parameter_annotations"> </td>
946 </tr></tbody>
947 </table></div>
948 </div>
949 <div class="refsect3">
950 <a name="prelude-client-is-setup-needed.returns"></a><h4>Returns</h4>
951 <p> TRUE if setup is needed, FALSE otherwise.</p>
952 </div>
953 </div>
954 <hr>
955 <div class="refsect2">
956 <a name="prelude-client-get-profile"></a><h3>prelude_client_get_profile ()</h3>
957 <pre class="programlisting"><a class="link" href="libprelude-prelude-client-profile.html#prelude-client-profile-t" title="prelude_client_profile_t"><span class="returnvalue">prelude_client_profile_t</span></a> *
958 prelude_client_get_profile (<em class="parameter"><code><a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> *client</code></em>);</pre>
959 </div>
960 <hr>
961 <div class="refsect2">
962 <a name="prelude-client-new-msgbuf"></a><h3>prelude_client_new_msgbuf ()</h3>
963 <pre class="programlisting"><span class="returnvalue">int</span>
964 prelude_client_new_msgbuf (<em class="parameter"><code><a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> *client</code></em>,
965 <em class="parameter"><code><a class="link" href="libprelude-prelude-msgbuf.html#prelude-msgbuf-t" title="prelude_msgbuf_t"><span class="type">prelude_msgbuf_t</span></a> **msgbuf</code></em>);</pre>
966 </div>
967 <hr>
968 <div class="refsect2">
969 <a name="prelude-client-handle-msg-default"></a><h3>prelude_client_handle_msg_default ()</h3>
970 <pre class="programlisting"><span class="returnvalue">int</span>
971 prelude_client_handle_msg_default (<em class="parameter"><code><a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> *client</code></em>,
972 <em class="parameter"><code><a class="link" href="libprelude-prelude-msg.html#prelude-msg-t" title="prelude_msg_t"><span class="type">prelude_msg_t</span></a> *msg</code></em>,
973 <em class="parameter"><code><a class="link" href="libprelude-prelude-msgbuf.html#prelude-msgbuf-t" title="prelude_msgbuf_t"><span class="type">prelude_msgbuf_t</span></a> *msgbuf</code></em>);</pre>
974 </div>
975 <hr>
976 <div class="refsect2">
977 <a name="prelude-client-get-setup-error"></a><h3>prelude_client_get_setup_error ()</h3>
978 <pre class="programlisting">const <span class="returnvalue">char</span> *
979 prelude_client_get_setup_error (<em class="parameter"><code><a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> *client</code></em>);</pre>
980 <div class="warning"><p><code class="literal">prelude_client_get_setup_error</code> is deprecated and should not be used in newly-written code.</p></div>
981 </div>
982 <hr>
983 <div class="refsect2">
984 <a name="prelude-client-print-setup-error"></a><h3>prelude_client_print_setup_error ()</h3>
985 <pre class="programlisting"><span class="returnvalue">void</span>
986 prelude_client_print_setup_error (<em class="parameter"><code><a class="link" href="libprelude-prelude-client.html#prelude-client-t" title="prelude_client_t"><span class="type">prelude_client_t</span></a> *client</code></em>);</pre>
987 </div>
988 </div>
989 <div class="refsect1">
990 <a name="libprelude-prelude-client.other_details"></a><h2>Types and Values</h2>
991 <div class="refsect2">
992 <a name="prelude-client-exit-status-t"></a><h3>enum prelude_client_exit_status_t</h3>
993 <div class="refsect3">
994 <a name="prelude-client-exit-status-t.members"></a><h4>Members</h4>
995 <div class="informaltable"><table width="100%" border="0">
996 <colgroup>
997 <col width="300px" class="enum_members_name">
998 <col class="enum_members_description">
999 <col width="200px" class="enum_members_annotations">
1000 </colgroup>
1001 <tbody>
1002 <tr>
1003 <td class="enum_member_name"><p><a name="PRELUDE-CLIENT-EXIT-STATUS-SUCCESS:CAPS"></a>PRELUDE_CLIENT_EXIT_STATUS_SUCCESS</p></td>
1004 <td> </td>
1005 <td> </td>
1006 </tr>
1007 <tr>
1008 <td class="enum_member_name"><p><a name="PRELUDE-CLIENT-EXIT-STATUS-FAILURE:CAPS"></a>PRELUDE_CLIENT_EXIT_STATUS_FAILURE</p></td>
1009 <td> </td>
1010 <td> </td>
1011 </tr>
1012 </tbody>
1013 </table></div>
1014 </div>
1015 </div>
1016 <hr>
1017 <div class="refsect2">
1018 <a name="prelude-client-flags-t"></a><h3>enum prelude_client_flags_t</h3>
1019 <div class="refsect3">
1020 <a name="prelude-client-flags-t.members"></a><h4>Members</h4>
1021 <div class="informaltable"><table width="100%" border="0">
1022 <colgroup>
1023 <col width="300px" class="enum_members_name">
1024 <col class="enum_members_description">
1025 <col width="200px" class="enum_members_annotations">
1026 </colgroup>
1027 <tbody>
1028 <tr>
1029 <td class="enum_member_name"><p><a name="PRELUDE-CLIENT-FLAGS-ASYNC-SEND:CAPS"></a>PRELUDE_CLIENT_FLAGS_ASYNC_SEND</p></td>
1030 <td> </td>
1031 <td> </td>
1032 </tr>
1033 <tr>
1034 <td class="enum_member_name"><p><a name="PRELUDE-CLIENT-FLAGS-ASYNC-TIMER:CAPS"></a>PRELUDE_CLIENT_FLAGS_ASYNC_TIMER</p></td>
1035 <td> </td>
1036 <td> </td>
1037 </tr>
1038 <tr>
1039 <td class="enum_member_name"><p><a name="PRELUDE-CLIENT-FLAGS-HEARTBEAT:CAPS"></a>PRELUDE_CLIENT_FLAGS_HEARTBEAT</p></td>
1040 <td> </td>
1041 <td> </td>
1042 </tr>
1043 <tr>
1044 <td class="enum_member_name"><p><a name="PRELUDE-CLIENT-FLAGS-CONNECT:CAPS"></a>PRELUDE_CLIENT_FLAGS_CONNECT</p></td>
1045 <td> </td>
1046 <td> </td>
1047 </tr>
1048 <tr>
1049 <td class="enum_member_name"><p><a name="PRELUDE-CLIENT-FLAGS-AUTOCONFIG:CAPS"></a>PRELUDE_CLIENT_FLAGS_AUTOCONFIG</p></td>
1050 <td> </td>
1051 <td> </td>
1052 </tr>
1053 </tbody>
1054 </table></div>
1055 </div>
1056 </div>
1057 <hr>
1058 <div class="refsect2">
1059 <a name="prelude-client-t"></a><h3>prelude_client_t</h3>
1060 <pre class="programlisting">typedef struct prelude_client prelude_client_t;
1061 </pre>
1062 </div>
1063 </div>
1064 </div>
1065 <div class="footer">
1066 <hr>Generated by GTK-Doc V1.28</div>
1067 </body>
1068 </html>