libprelude-doc 4.1.0-4 / usr / share / gtk-doc / html / libprelude / libprelude-prelude-msgbuf.html

This file is indexed.

/usr/share/gtk-doc/html/libprelude/libprelude-prelude-msgbuf.html is in libprelude-doc 4.1.0-4.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
<!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-msgbuf: libprelude Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libprelude Reference Manual">
<link rel="up" href="ch01.html" title="[Insert title here]">
<link rel="prev" href="libprelude-idmef-message-print.html" title="idmef-message-print">
<link rel="next" href="libprelude-idmef-message-write.html" title="idmef-message-write">
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#libprelude-prelude-msgbuf.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libprelude-idmef-message-print.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libprelude-idmef-message-write.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libprelude-prelude-msgbuf"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libprelude-prelude-msgbuf.top_of_page"></a>prelude-msgbuf</span></h2>
<p>prelude-msgbuf</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libprelude-prelude-msgbuf.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="libprelude-prelude-msgbuf.html#prelude-msgbuf-new" title="prelude_msgbuf_new ()">prelude_msgbuf_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libprelude-prelude-msgbuf.html#prelude-msgbuf-destroy" title="prelude_msgbuf_destroy ()">prelude_msgbuf_destroy</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<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>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="libprelude-prelude-msgbuf.html#prelude-msgbuf-set" title="prelude_msgbuf_set ()">prelude_msgbuf_set</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libprelude-prelude-msg.html#prelude-msg-t" title="prelude_msg_t"><span class="returnvalue">prelude_msg_t</span></a> *
</td>
<td class="function_name">
<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>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<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>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<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>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span> *
</td>
<td class="function_name">
<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>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<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>
</td>
</tr>
<tr>
<td class="function_type">
<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>
</td>
<td class="function_name">
<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>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libprelude-prelude-msgbuf.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="typedef_keyword">typedef</td>
<td class="function_name"><a class="link" href="libprelude-prelude-msgbuf.html#prelude-msgbuf-t" title="prelude_msgbuf_t">prelude_msgbuf_t</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<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>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libprelude-prelude-msgbuf.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libprelude-prelude-msgbuf.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="prelude-msgbuf-new"></a><h3>prelude_msgbuf_new ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
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>
<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>
.
You can then write data to <em class="parameter"><code>msgbuf</code></em>
 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>
<p>When the message buffer is full, the message will be flushed using the
user provided callback.</p>
<div class="refsect3">
<a name="prelude-msgbuf-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>msgbuf</p></td>
<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>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="prelude-msgbuf-new.returns"></a><h4>Returns</h4>
<p> 0 on success, or a negative value if an error occured.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="prelude-msgbuf-destroy"></a><h3>prelude_msgbuf_destroy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
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>
<p>Destroy <em class="parameter"><code>msgbuf</code></em>
, all data remaining will be flushed.</p>
<div class="refsect3">
<a name="prelude-msgbuf-destroy.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>msgbuf</p></td>
<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>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="prelude-msgbuf-mark-end"></a><h3>prelude_msgbuf_mark_end ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
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>
<p>This function should be called to tell the msgbuf subsystem
that you finished writing your message.</p>
<div class="refsect3">
<a name="prelude-msgbuf-mark-end.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>msgbuf</p></td>
<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>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="prelude-msgbuf-set"></a><h3>prelude_msgbuf_set ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
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>,
                    <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>,
                    <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>,
                    <em class="parameter"><code>const <span class="type">void</span> *data</code></em>);</pre>
<p>prelude_msgbuf_set() append <em class="parameter"><code>len</code></em>
 bytes of data from the <em class="parameter"><code>data</code></em>
 buffer
to the <em class="parameter"><code>msgbuf</code></em>
 object representing a message. The data is tagged with <em class="parameter"><code>tag</code></em>
.</p>
<div class="refsect3">
<a name="prelude-msgbuf-set.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>msgbuf</p></td>
<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>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tag</p></td>
<td class="parameter_description"><p>8 bits unsigned integer describing the kind of data.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>len</p></td>
<td class="parameter_description"><p>len of the data chunk.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>Pointer to the data.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="prelude-msgbuf-set.returns"></a><h4>Returns</h4>
<p> 0 on success, a negative value if an error occured.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="prelude-msgbuf-get-msg"></a><h3>prelude_msgbuf_get_msg ()</h3>
<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> *
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>
<div class="refsect3">
<a name="prelude-msgbuf-get-msg.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>msgbuf</p></td>
<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>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="prelude-msgbuf-get-msg.returns"></a><h4>Returns</h4>
<p> This function return the current message associated with
the message buffer.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="prelude-msgbuf-set-callback"></a><h3>prelude_msgbuf_set_callback ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
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>,
                             <em class="parameter"><code><span class="type">int</span> (*send_msg) (prelude_msgbuf_t *msgbuf, prelude_msg_t *msg)</code></em>);</pre>
<p>Associate an application specific callback to this <em class="parameter"><code>msgbuf</code></em>
.</p>
<div class="refsect3">
<a name="prelude-msgbuf-set-callback.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>msgbuf</p></td>
<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>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>send_msg</p></td>
<td class="parameter_description"><p>Pointer to a function for sending a message.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="prelude-msgbuf-set-data"></a><h3>prelude_msgbuf_set_data ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
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>,
                         <em class="parameter"><code><span class="type">void</span> *data</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="prelude-msgbuf-get-data"></a><h3>prelude_msgbuf_get_data ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> *
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>
</div>
<hr>
<div class="refsect2">
<a name="prelude-msgbuf-set-flags"></a><h3>prelude_msgbuf_set_flags ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
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>,
                          <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>
</div>
<hr>
<div class="refsect2">
<a name="prelude-msgbuf-get-flags"></a><h3>prelude_msgbuf_get_flags ()</h3>
<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>
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>
</div>
</div>
<div class="refsect1">
<a name="libprelude-prelude-msgbuf.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="prelude-msgbuf-t"></a><h3>prelude_msgbuf_t</h3>
<pre class="programlisting">typedef struct prelude_msgbuf prelude_msgbuf_t;
</pre>
</div>
<hr>
<div class="refsect2">
<a name="prelude-msgbuf-flags-t"></a><h3>enum prelude_msgbuf_flags_t</h3>
<div class="refsect3">
<a name="prelude-msgbuf-flags-t.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody><tr>
<td class="enum_member_name"><p><a name="PRELUDE-MSGBUF-FLAGS-ASYNC:CAPS"></a>PRELUDE_MSGBUF_FLAGS_ASYNC</p></td>
<td> </td>
<td> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.