Debian Codegraph @

docs/api/html/libprelude-prelude-msgbuf.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-msgbuf: 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-idmef-message-print.html" title="idmef-message-print">
10 <link rel="next" href="libprelude-idmef-message-write.html" title="idmef-message-write">
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-msgbuf.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-idmef-message-print.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
23 <td><a accesskey="n" href="libprelude-idmef-message-write.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-msgbuf"></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-msgbuf.top_of_page"></a>prelude-msgbuf</span></h2>
30 <p>prelude-msgbuf</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-msgbuf.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 <span class="returnvalue">int</span>
45 </td>
46 <td class="function_name">
47 <a class="link" href="libprelude-prelude-msgbuf.html#prelude-msgbuf-new" title="prelude_msgbuf_new ()">prelude_msgbuf_new</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-msgbuf.html#prelude-msgbuf-destroy" title="prelude_msgbuf_destroy ()">prelude_msgbuf_destroy</a> <span class="c_punctuation">()</span>
56 </td>
57 </tr>
58 <tr>
59 <td class="function_type">
60 <span class="returnvalue">void</span>
61 </td>
62 <td class="function_name">
63 <a class="link" href="libprelude-prelude-msgbuf.html#prelude-msgbuf-mark-end" title="prelude_msgbuf_mark_end ()">prelude_msgbuf_mark_end</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-msgbuf.html#prelude-msgbuf-set" title="prelude_msgbuf_set ()">prelude_msgbuf_set</a> <span class="c_punctuation">()</span>
72 </td>
73 </tr>
74 <tr>
75 <td class="function_type">
76 <a class="link" href="libprelude-prelude-msg.html#prelude-msg-t" title="prelude_msg_t"><span class="returnvalue">prelude_msg_t</span></a> *
77 </td>
78 <td class="function_name">
79 <a class="link" href="libprelude-prelude-msgbuf.html#prelude-msgbuf-get-msg" title="prelude_msgbuf_get_msg ()">prelude_msgbuf_get_msg</a> <span class="c_punctuation">()</span>
80 </td>
81 </tr>
82 <tr>
83 <td class="function_type">
84 <span class="returnvalue">void</span>
85 </td>
86 <td class="function_name">
87 <a class="link" href="libprelude-prelude-msgbuf.html#prelude-msgbuf-set-callback" title="prelude_msgbuf_set_callback ()">prelude_msgbuf_set_callback</a> <span class="c_punctuation">()</span>
88 </td>
89 </tr>
90 <tr>
91 <td class="function_type">
92 <span class="returnvalue">void</span>
93 </td>
94 <td class="function_name">
95 <a class="link" href="libprelude-prelude-msgbuf.html#prelude-msgbuf-set-data" title="prelude_msgbuf_set_data ()">prelude_msgbuf_set_data</a> <span class="c_punctuation">()</span>
96 </td>
97 </tr>
98 <tr>
99 <td class="function_type">
100 <span class="returnvalue">void</span> *
101 </td>
102 <td class="function_name">
103 <a class="link" href="libprelude-prelude-msgbuf.html#prelude-msgbuf-get-data" title="prelude_msgbuf_get_data ()">prelude_msgbuf_get_data</a> <span class="c_punctuation">()</span>
104 </td>
105 </tr>
106 <tr>
107 <td class="function_type">
108 <span class="returnvalue">void</span>
109 </td>
110 <td class="function_name">
111 <a class="link" href="libprelude-prelude-msgbuf.html#prelude-msgbuf-set-flags" title="prelude_msgbuf_set_flags ()">prelude_msgbuf_set_flags</a> <span class="c_punctuation">()</span>
112 </td>
113 </tr>
114 <tr>
115 <td class="function_type">
116 <a class="link" href="libprelude-prelude-msgbuf.html#prelude-msgbuf-flags-t" title="enum prelude_msgbuf_flags_t"><span class="returnvalue">prelude_msgbuf_flags_t</span></a>
117 </td>
118 <td class="function_name">
119 <a class="link" href="libprelude-prelude-msgbuf.html#prelude-msgbuf-get-flags" title="prelude_msgbuf_get_flags ()">prelude_msgbuf_get_flags</a> <span class="c_punctuation">()</span>
120 </td>
121 </tr>
122 </tbody>
123 </table></div>
124 </div>
125 <div class="refsect1">
126 <a name="libprelude-prelude-msgbuf.other"></a><h2>Types and Values</h2>
127 <div class="informaltable"><table width="100%" border="0">
128 <colgroup>
129 <col width="150px" class="name">
130 <col class="description">
131 </colgroup>
132 <tbody>
133 <tr>
134 <td class="typedef_keyword">typedef</td>
135 <td class="function_name"><a class="link" href="libprelude-prelude-msgbuf.html#prelude-msgbuf-t" title="prelude_msgbuf_t">prelude_msgbuf_t</a></td>
136 </tr>
137 <tr>
138 <td class="datatype_keyword">enum</td>
139 <td class="function_name"><a class="link" href="libprelude-prelude-msgbuf.html#prelude-msgbuf-flags-t" title="enum prelude_msgbuf_flags_t">prelude_msgbuf_flags_t</a></td>
140 </tr>
141 </tbody>
142 </table></div>
143 </div>
144 <div class="refsect1">
145 <a name="libprelude-prelude-msgbuf.description"></a><h2>Description</h2>
146 </div>
147 <div class="refsect1">
148 <a name="libprelude-prelude-msgbuf.functions_details"></a><h2>Functions</h2>
149 <div class="refsect2">
150 <a name="prelude-msgbuf-new"></a><h3>prelude_msgbuf_new ()</h3>
151 <pre class="programlisting"><span class="returnvalue">int</span>
152 prelude_msgbuf_new (<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>
153 <p>Create a new <a class="link" href="libprelude-prelude-msgbuf.html#prelude-msgbuf-t" title="prelude_msgbuf_t"><span class="type">prelude_msgbuf_t</span></a> object and store it into <em class="parameter"><code>msgbuf</code></em>
154 .
155 You can then write data to <em class="parameter"><code>msgbuf</code></em>
156 using the <a class="link" href="libprelude-prelude-msgbuf.html#prelude-msgbuf-set" title="prelude_msgbuf_set ()"><code class="function">prelude_msgbuf_set()</code></a> function.</p>
157 <p>When the message buffer is full, the message will be flushed using the
158 user provided callback.</p>
159 <div class="refsect3">
160 <a name="prelude-msgbuf-new.parameters"></a><h4>Parameters</h4>
161 <div class="informaltable"><table width="100%" border="0">
162 <colgroup>
163 <col width="150px" class="parameters_name">
164 <col class="parameters_description">
165 <col width="200px" class="parameters_annotations">
166 </colgroup>
167 <tbody><tr>
168 <td class="parameter_name"><p>msgbuf</p></td>
169 <td class="parameter_description"><p>Pointer where to store the created <a class="link" href="libprelude-prelude-msgbuf.html#prelude-msgbuf-t" title="prelude_msgbuf_t"><span class="type">prelude_msgbuf_t</span></a> object.</p></td>
170 <td class="parameter_annotations"> </td>
171 </tr></tbody>
172 </table></div>
173 </div>
174 <div class="refsect3">
175 <a name="prelude-msgbuf-new.returns"></a><h4>Returns</h4>
176 <p> 0 on success, or a negative value if an error occured.</p>
177 </div>
178 </div>
179 <hr>
180 <div class="refsect2">
181 <a name="prelude-msgbuf-destroy"></a><h3>prelude_msgbuf_destroy ()</h3>
182 <pre class="programlisting"><span class="returnvalue">void</span>
183 prelude_msgbuf_destroy (<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>
184 <p>Destroy <em class="parameter"><code>msgbuf</code></em>
185 , all data remaining will be flushed.</p>
186 <div class="refsect3">
187 <a name="prelude-msgbuf-destroy.parameters"></a><h4>Parameters</h4>
188 <div class="informaltable"><table width="100%" border="0">
189 <colgroup>
190 <col width="150px" class="parameters_name">
191 <col class="parameters_description">
192 <col width="200px" class="parameters_annotations">
193 </colgroup>
194 <tbody><tr>
195 <td class="parameter_name"><p>msgbuf</p></td>
196 <td class="parameter_description"><p>Pointer on a <a class="link" href="libprelude-prelude-msgbuf.html#prelude-msgbuf-t" title="prelude_msgbuf_t"><span class="type">prelude_msgbuf_t</span></a> object.</p></td>
197 <td class="parameter_annotations"> </td>
198 </tr></tbody>
199 </table></div>
200 </div>
201 </div>
202 <hr>
203 <div class="refsect2">
204 <a name="prelude-msgbuf-mark-end"></a><h3>prelude_msgbuf_mark_end ()</h3>
205 <pre class="programlisting"><span class="returnvalue">void</span>
206 prelude_msgbuf_mark_end (<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>
207 <p>This function should be called to tell the msgbuf subsystem
208 that you finished writing your message.</p>
209 <div class="refsect3">
210 <a name="prelude-msgbuf-mark-end.parameters"></a><h4>Parameters</h4>
211 <div class="informaltable"><table width="100%" border="0">
212 <colgroup>
213 <col width="150px" class="parameters_name">
214 <col class="parameters_description">
215 <col width="200px" class="parameters_annotations">
216 </colgroup>
217 <tbody><tr>
218 <td class="parameter_name"><p>msgbuf</p></td>
219 <td class="parameter_description"><p>Pointer on <a class="link" href="libprelude-prelude-msgbuf.html#prelude-msgbuf-t" title="prelude_msgbuf_t"><span class="type">prelude_msgbuf_t</span></a> object.</p></td>
220 <td class="parameter_annotations"> </td>
221 </tr></tbody>
222 </table></div>
223 </div>
224 </div>
225 <hr>
226 <div class="refsect2">
227 <a name="prelude-msgbuf-set"></a><h3>prelude_msgbuf_set ()</h3>
228 <pre class="programlisting"><span class="returnvalue">int</span>
229 prelude_msgbuf_set (<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>,
230 <em class="parameter"><code><a class="link" href="libprelude-prelude-inttypes.html#uint8-t" title="uint8_t"><span class="type">uint8_t</span></a> tag</code></em>,
231 <em class="parameter"><code><a class="link" href="libprelude-prelude-inttypes.html#uint32-t" title="uint32_t"><span class="type">uint32_t</span></a> len</code></em>,
232 <em class="parameter"><code>const <span class="type">void</span> *data</code></em>);</pre>
233 <p>prelude_msgbuf_set() append <em class="parameter"><code>len</code></em>
234 bytes of data from the <em class="parameter"><code>data</code></em>
235 buffer
236 to the <em class="parameter"><code>msgbuf</code></em>
237 object representing a message. The data is tagged with <em class="parameter"><code>tag</code></em>
238 .</p>
239 <div class="refsect3">
240 <a name="prelude-msgbuf-set.parameters"></a><h4>Parameters</h4>
241 <div class="informaltable"><table width="100%" border="0">
242 <colgroup>
243 <col width="150px" class="parameters_name">
244 <col class="parameters_description">
245 <col width="200px" class="parameters_annotations">
246 </colgroup>
247 <tbody>
248 <tr>
249 <td class="parameter_name"><p>msgbuf</p></td>
250 <td class="parameter_description"><p>Pointer on a <a class="link" href="libprelude-prelude-msgbuf.html#prelude-msgbuf-t" title="prelude_msgbuf_t"><span class="type">prelude_msgbuf_t</span></a> object to store the data to.</p></td>
251 <td class="parameter_annotations"> </td>
252 </tr>
253 <tr>
254 <td class="parameter_name"><p>tag</p></td>
255 <td class="parameter_description"><p>8 bits unsigned integer describing the kind of data.</p></td>
256 <td class="parameter_annotations"> </td>
257 </tr>
258 <tr>
259 <td class="parameter_name"><p>len</p></td>
260 <td class="parameter_description"><p>len of the data chunk.</p></td>
261 <td class="parameter_annotations"> </td>
262 </tr>
263 <tr>
264 <td class="parameter_name"><p>data</p></td>
265 <td class="parameter_description"><p>Pointer to the data.</p></td>
266 <td class="parameter_annotations"> </td>
267 </tr>
268 </tbody>
269 </table></div>
270 </div>
271 <div class="refsect3">
272 <a name="prelude-msgbuf-set.returns"></a><h4>Returns</h4>
273 <p> 0 on success, a negative value if an error occured.</p>
274 </div>
275 </div>
276 <hr>
277 <div class="refsect2">
278 <a name="prelude-msgbuf-get-msg"></a><h3>prelude_msgbuf_get_msg ()</h3>
279 <pre class="programlisting"><a class="link" href="libprelude-prelude-msg.html#prelude-msg-t" title="prelude_msg_t"><span class="returnvalue">prelude_msg_t</span></a> *
280 prelude_msgbuf_get_msg (<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>
281 <div class="refsect3">
282 <a name="prelude-msgbuf-get-msg.parameters"></a><h4>Parameters</h4>
283 <div class="informaltable"><table width="100%" border="0">
284 <colgroup>
285 <col width="150px" class="parameters_name">
286 <col class="parameters_description">
287 <col width="200px" class="parameters_annotations">
288 </colgroup>
289 <tbody><tr>
290 <td class="parameter_name"><p>msgbuf</p></td>
291 <td class="parameter_description"><p>Pointer on a <a class="link" href="libprelude-prelude-msgbuf.html#prelude-msgbuf-t" title="prelude_msgbuf_t"><span class="type">prelude_msgbuf_t</span></a> object.</p></td>
292 <td class="parameter_annotations"> </td>
293 </tr></tbody>
294 </table></div>
295 </div>
296 <div class="refsect3">
297 <a name="prelude-msgbuf-get-msg.returns"></a><h4>Returns</h4>
298 <p> This function return the current message associated with
299 the message buffer.</p>
300 </div>
301 </div>
302 <hr>
303 <div class="refsect2">
304 <a name="prelude-msgbuf-set-callback"></a><h3>prelude_msgbuf_set_callback ()</h3>
305 <pre class="programlisting"><span class="returnvalue">void</span>
306 prelude_msgbuf_set_callback (<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>,
307 <em class="parameter"><code><span class="type">int</span> (*send_msg) (prelude_msgbuf_t *msgbuf, prelude_msg_t *msg)</code></em>);</pre>
308 <p>Associate an application specific callback to this <em class="parameter"><code>msgbuf</code></em>
309 .</p>
310 <div class="refsect3">
311 <a name="prelude-msgbuf-set-callback.parameters"></a><h4>Parameters</h4>
312 <div class="informaltable"><table width="100%" border="0">
313 <colgroup>
314 <col width="150px" class="parameters_name">
315 <col class="parameters_description">
316 <col width="200px" class="parameters_annotations">
317 </colgroup>
318 <tbody>
319 <tr>
320 <td class="parameter_name"><p>msgbuf</p></td>
321 <td class="parameter_description"><p>Pointer on a <a class="link" href="libprelude-prelude-msgbuf.html#prelude-msgbuf-t" title="prelude_msgbuf_t"><span class="type">prelude_msgbuf_t</span></a> object.</p></td>
322 <td class="parameter_annotations"> </td>
323 </tr>
324 <tr>
325 <td class="parameter_name"><p>send_msg</p></td>
326 <td class="parameter_description"><p>Pointer to a function for sending a message.</p></td>
327 <td class="parameter_annotations"> </td>
328 </tr>
329 </tbody>
330 </table></div>
331 </div>
332 </div>
333 <hr>
334 <div class="refsect2">
335 <a name="prelude-msgbuf-set-data"></a><h3>prelude_msgbuf_set_data ()</h3>
336 <pre class="programlisting"><span class="returnvalue">void</span>
337 prelude_msgbuf_set_data (<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>,
338 <em class="parameter"><code><span class="type">void</span> *data</code></em>);</pre>
339 </div>
340 <hr>
341 <div class="refsect2">
342 <a name="prelude-msgbuf-get-data"></a><h3>prelude_msgbuf_get_data ()</h3>
343 <pre class="programlisting"><span class="returnvalue">void</span> *
344 prelude_msgbuf_get_data (<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>
345 </div>
346 <hr>
347 <div class="refsect2">
348 <a name="prelude-msgbuf-set-flags"></a><h3>prelude_msgbuf_set_flags ()</h3>
349 <pre class="programlisting"><span class="returnvalue">void</span>
350 prelude_msgbuf_set_flags (<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>,
351 <em class="parameter"><code><a class="link" href="libprelude-prelude-msgbuf.html#prelude-msgbuf-flags-t" title="enum prelude_msgbuf_flags_t"><span class="type">prelude_msgbuf_flags_t</span></a> flags</code></em>);</pre>
352 </div>
353 <hr>
354 <div class="refsect2">
355 <a name="prelude-msgbuf-get-flags"></a><h3>prelude_msgbuf_get_flags ()</h3>
356 <pre class="programlisting"><a class="link" href="libprelude-prelude-msgbuf.html#prelude-msgbuf-flags-t" title="enum prelude_msgbuf_flags_t"><span class="returnvalue">prelude_msgbuf_flags_t</span></a>
357 prelude_msgbuf_get_flags (<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>
358 </div>
359 </div>
360 <div class="refsect1">
361 <a name="libprelude-prelude-msgbuf.other_details"></a><h2>Types and Values</h2>
362 <div class="refsect2">
363 <a name="prelude-msgbuf-t"></a><h3>prelude_msgbuf_t</h3>
364 <pre class="programlisting">typedef struct prelude_msgbuf prelude_msgbuf_t;
365 </pre>
366 </div>
367 <hr>
368 <div class="refsect2">
369 <a name="prelude-msgbuf-flags-t"></a><h3>enum prelude_msgbuf_flags_t</h3>
370 <div class="refsect3">
371 <a name="prelude-msgbuf-flags-t.members"></a><h4>Members</h4>
372 <div class="informaltable"><table width="100%" border="0">
373 <colgroup>
374 <col width="300px" class="enum_members_name">
375 <col class="enum_members_description">
376 <col width="200px" class="enum_members_annotations">
377 </colgroup>
378 <tbody><tr>
379 <td class="enum_member_name"><p><a name="PRELUDE-MSGBUF-FLAGS-ASYNC:CAPS"></a>PRELUDE_MSGBUF_FLAGS_ASYNC</p></td>
380 <td> </td>
381 <td> </td>
382 </tr></tbody>
383 </table></div>
384 </div>
385 </div>
386 </div>
387 </div>
388 <div class="footer">
389 <hr>Generated by GTK-Doc V1.28</div>
390 </body>
391 </html>