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
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>prelude-msg</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
<link rel="start" href="index.html" title="Prelude library Reference Manual">
<link rel="up" href="ch04.html" title="Others">
<link rel="prev" href="libprelude-prelude-log.html" title="prelude-log">
<link rel="next" href="libprelude-prelude-option.html" title="prelude-option">
<meta name="generator" content="GTK-Doc V1.5 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="pt01.html" title="Part I. Using libprelude to interoperate with prelude-manager">
<link rel="part" href="pt02.html" title="Part II. Sending events with libprelude">
<link rel="chapter" href="ch01.html" title="The low level IDMEF API">
<link rel="chapter" href="ch02.html" title="The high level IDMEF API">
<link rel="part" href="pt03.html" title="Part III. Reading events from the collector">
<link rel="part" href="pt04.html" title="Part IV. Filtering operation on IDMEF messages">
<link rel="chapter" href="ch03.html" title="Utility functions">
<link rel="chapter" href="ch04.html" title="Others">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libprelude-prelude-log.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch04.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Prelude library Reference Manual</th>
<td><a accesskey="n" href="libprelude-prelude-option.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#top_of_page" class="shortcut">Top</a>
 | 
<a href="#desc" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libprelude-prelude-msg"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="top_of_page"></a>prelude-msg</span></h2>
<p>prelude-msg — Prelude Messaging API</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
typedef <a href="libprelude-prelude-msg.html#prelude-msg-t">prelude_msg_t</a>;
enum <a href="libprelude-prelude-msg.html#prelude-msg-priority-t">prelude_msg_priority_t</a>;
int <a href="libprelude-prelude-msg.html#prelude-msg-read">prelude_msg_read</a> (<a href="libprelude-prelude-msg.html#prelude-msg-t">prelude_msg_t</a> **msg,
<a href="libprelude-prelude-io.html#prelude-io-t">prelude_io_t</a> *pio);
int <a href="libprelude-prelude-msg.html#prelude-msg-forward">prelude_msg_forward</a> (<a href="libprelude-prelude-msg.html#prelude-msg-t">prelude_msg_t</a> *msg,
<a href="libprelude-prelude-io.html#prelude-io-t">prelude_io_t</a> *dst,
<a href="libprelude-prelude-io.html#prelude-io-t">prelude_io_t</a> *src);
int <a href="libprelude-prelude-msg.html#prelude-msg-get">prelude_msg_get</a> (<a href="libprelude-prelude-msg.html#prelude-msg-t">prelude_msg_t</a> *msg,
<a href="libprelude-prelude-inttypes.html#uint8-t">uint8_t</a> *tag,
<a href="libprelude-prelude-inttypes.html#uint32-t">uint32_t</a> *len,
void **buf);
void <a href="libprelude-prelude-msg.html#prelude-msg-recycle">prelude_msg_recycle</a> (<a href="libprelude-prelude-msg.html#prelude-msg-t">prelude_msg_t</a> *msg);
void <a href="libprelude-prelude-msg.html#prelude-msg-mark-end">prelude_msg_mark_end</a> (<a href="libprelude-prelude-msg.html#prelude-msg-t">prelude_msg_t</a> *msg);
int <a href="libprelude-prelude-msg.html#prelude-msg-dynamic-new">prelude_msg_dynamic_new</a> (<a href="libprelude-prelude-msg.html#prelude-msg-t">prelude_msg_t</a> **ret,
int (*flush_msg_cb) (prelude_msg_t **msg, void *data),
void *data);
int <a href="libprelude-prelude-msg.html#prelude-msg-new">prelude_msg_new</a> (<a href="libprelude-prelude-msg.html#prelude-msg-t">prelude_msg_t</a> **ret,
size_t msgcount,
size_t msglen,
<a href="libprelude-prelude-inttypes.html#uint8-t">uint8_t</a> tag,
<a href="libprelude-prelude-msg.html#prelude-msg-priority-t">prelude_msg_priority_t</a> priority);
int <a href="libprelude-prelude-msg.html#prelude-msg-set">prelude_msg_set</a> (<a href="libprelude-prelude-msg.html#prelude-msg-t">prelude_msg_t</a> *msg,
<a href="libprelude-prelude-inttypes.html#uint8-t">uint8_t</a> tag,
<a href="libprelude-prelude-inttypes.html#uint32-t">uint32_t</a> len,
const void *data);
int <a href="libprelude-prelude-msg.html#prelude-msg-write">prelude_msg_write</a> (<a href="libprelude-prelude-msg.html#prelude-msg-t">prelude_msg_t</a> *msg,
<a href="libprelude-prelude-io.html#prelude-io-t">prelude_io_t</a> *dst);
void <a href="libprelude-prelude-msg.html#prelude-msg-set-tag">prelude_msg_set_tag</a> (<a href="libprelude-prelude-msg.html#prelude-msg-t">prelude_msg_t</a> *msg,
<a href="libprelude-prelude-inttypes.html#uint8-t">uint8_t</a> tag);
void <a href="libprelude-prelude-msg.html#prelude-msg-set-priority">prelude_msg_set_priority</a> (<a href="libprelude-prelude-msg.html#prelude-msg-t">prelude_msg_t</a> *msg,
<a href="libprelude-prelude-msg.html#prelude-msg-priority-t">prelude_msg_priority_t</a> priority);
<a href="libprelude-prelude-inttypes.html#uint8-t">uint8_t</a> <a href="libprelude-prelude-msg.html#prelude-msg-get-tag">prelude_msg_get_tag</a> (<a href="libprelude-prelude-msg.html#prelude-msg-t">prelude_msg_t</a> *msg);
<a href="libprelude-prelude-msg.html#prelude-msg-priority-t">prelude_msg_priority_t</a> <a href="libprelude-prelude-msg.html#prelude-msg-get-priority">prelude_msg_get_priority</a>
(<a href="libprelude-prelude-msg.html#prelude-msg-t">prelude_msg_t</a> *msg);
<a href="libprelude-prelude-inttypes.html#uint32-t">uint32_t</a> <a href="libprelude-prelude-msg.html#prelude-msg-get-len">prelude_msg_get_len</a> (<a href="libprelude-prelude-msg.html#prelude-msg-t">prelude_msg_t</a> *msg);
<a href="libprelude-prelude-inttypes.html#uint32-t">uint32_t</a> <a href="libprelude-prelude-msg.html#prelude-msg-get-datalen">prelude_msg_get_datalen</a> (<a href="libprelude-prelude-msg.html#prelude-msg-t">prelude_msg_t</a> *msg);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="desc"></a><h2>Description</h2>
<p>
This Mesaging API is used for differents Prelude program to communicate
together. It feature compatibility between version, and use a way to describe
data similar to XML.
</p>
<p>
The Message header contain the protocol version, which is only to be used
in case the main protocol structure change (compatibility break), The tag
describe the kind of message, The fragment field may be used if a message
is sent in several time, The priority may be used by the receiving end
to priorityze task, The datalen contain the size of the whole message in
network byte order
</p>
<pre class="programlisting">
8bits 8bits 8bits 8bits 32bits
+--------+--------+--------+----------+------------------------------+
|version | tag |priority| fragment | datalen |
+--------+--------+--------+----------+------------------------------+
</pre>
<p>
</p>
<p>
Then the message itself contain submessage composed of :
A tag describing the kind of payload, the len of the payload (in network byte order),
the payload itself, and an end of message byte (0xff) in order to resynchronize in
case of problem.
</p>
<pre class="programlisting">
8bits 32bits 8bits
+--------+--------------------------------+-----------------+--------+
| tag | len | payload | 0xff |
+--------+--------------------------------+-----------------+--------+
</pre>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id392879"></a><h3>
<a name="prelude-msg-t"></a>prelude_msg_t</h3>
<a class="indexterm" name="id392891"></a><pre class="programlisting">typedef struct prelude_msg prelude_msg_t;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id392906"></a><h3>
<a name="prelude-msg-priority-t"></a>enum prelude_msg_priority_t</h3>
<a class="indexterm" name="id392918"></a><pre class="programlisting">typedef enum {
PRELUDE_MSG_PRIORITY_NONE = 0,
PRELUDE_MSG_PRIORITY_LOW = 1,
PRELUDE_MSG_PRIORITY_MID = 2,
PRELUDE_MSG_PRIORITY_HIGH = 3
} prelude_msg_priority_t;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id358758"></a><h3>
<a name="prelude-msg-read"></a>prelude_msg_read ()</h3>
<a class="indexterm" name="id358770"></a><pre class="programlisting">int prelude_msg_read (<a href="libprelude-prelude-msg.html#prelude-msg-t">prelude_msg_t</a> **msg,
<a href="libprelude-prelude-io.html#prelude-io-t">prelude_io_t</a> *pio);</pre>
<p>
Read a message on <i class="parameter"><tt>pio</tt></i> into <i class="parameter"><tt>msg</tt></i>. If <i class="parameter"><tt>msg</tt></i> is NULL, it is
allocated. This function will never block.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><i class="parameter"><tt>msg</tt></i> :</span></td>
<td> Pointer on a <a href="libprelude-prelude-msg.html#prelude-msg-t"><span class="type">prelude_msg_t</span></a> object address.
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>pio</tt></i> :</span></td>
<td> Pointer on a <a href="libprelude-prelude-io.html#prelude-io-t"><span class="type">prelude_io_t</span></a> object.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> 0 if reading the message is complete, or a <a href="libprelude-prelude-error.html#prelude-error-t"><span class="type">prelude_error_t</span></a>
error if an error occured. Take particular attention to <span class="type">PRELUDE_ERROR_EAGAIN</span>
and PRELUDE_ERROR_EOF.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id358895"></a><h3>
<a name="prelude-msg-forward"></a>prelude_msg_forward ()</h3>
<a class="indexterm" name="id358907"></a><pre class="programlisting">int prelude_msg_forward (<a href="libprelude-prelude-msg.html#prelude-msg-t">prelude_msg_t</a> *msg,
<a href="libprelude-prelude-io.html#prelude-io-t">prelude_io_t</a> *dst,
<a href="libprelude-prelude-io.html#prelude-io-t">prelude_io_t</a> *src);</pre>
<p>
<a href="libprelude-prelude-msg.html#prelude-msg-forward"><tt class="function">prelude_msg_forward()</tt></a> read the message corresponding to the <i class="parameter"><tt>msg</tt></i> object
containing the message header previously gathered using <tt class="function">prelude_msg_read_header()</tt>
from the <i class="parameter"><tt>src</tt></i> object, and transfer it to <i class="parameter"><tt>dst</tt></i>. The header is also transfered.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><i class="parameter"><tt>msg</tt></i> :</span></td>
<td> Pointer on a <a href="libprelude-prelude-msg.html#prelude-msg-t"><span class="type">prelude_msg_t</span></a> object containing a message header.
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>dst</tt></i> :</span></td>
<td> Pointer on a <a href="libprelude-prelude-io.html#prelude-io-t"><span class="type">prelude_io_t</span></a> object to send message to.
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>src</tt></i> :</span></td>
<td> Pointer on a <a href="libprelude-prelude-io.html#prelude-io-t"><span class="type">prelude_io_t</span></a> object to read message from.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> 0 on success, or a negative value if an error occured.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id409724"></a><h3>
<a name="prelude-msg-get"></a>prelude_msg_get ()</h3>
<a class="indexterm" name="id409736"></a><pre class="programlisting">int prelude_msg_get (<a href="libprelude-prelude-msg.html#prelude-msg-t">prelude_msg_t</a> *msg,
<a href="libprelude-prelude-inttypes.html#uint8-t">uint8_t</a> *tag,
<a href="libprelude-prelude-inttypes.html#uint32-t">uint32_t</a> *len,
void **buf);</pre>
<p>
<a href="libprelude-prelude-msg.html#prelude-msg-get"><tt class="function">prelude_msg_get()</tt></a> read the next data chunk contained in the message.
<i class="parameter"><tt>tag</tt></i> is updated to contain the kind of data the chunk contain.
<i class="parameter"><tt>len</tt></i> is updated to contain the len of the data chunk.
<i class="parameter"><tt>buf</tt></i> is updated to point on the data chunk.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><i class="parameter"><tt>msg</tt></i> :</span></td>
<td> Pointer on a <a href="libprelude-prelude-msg.html#prelude-msg-t"><span class="type">prelude_msg_t</span></a> object representing the message to get data from.
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>tag</tt></i> :</span></td>
<td> Pointer on a 8 bits unsigned integer to store the message tag.
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>len</tt></i> :</span></td>
<td> Pointer on a 32 bits unsigned integer to store the message len to.
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>buf</tt></i> :</span></td>
<td> Address of a pointer to store the buffer starting address.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> 0 on success, or a <a href="libprelude-prelude-error.html#prelude-error-t"><span class="type">prelude_error_t</span></a> value on error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id392189"></a><h3>
<a name="prelude-msg-recycle"></a>prelude_msg_recycle ()</h3>
<a class="indexterm" name="id392201"></a><pre class="programlisting">void prelude_msg_recycle (<a href="libprelude-prelude-msg.html#prelude-msg-t">prelude_msg_t</a> *msg);</pre>
<p>
Recycle <i class="parameter"><tt>msg</tt></i> so you can write at it again, even
thought it was written.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><i class="parameter"><tt>msg</tt></i> :</span></td>
<td> Pointer on <a href="libprelude-prelude-msg.html#prelude-msg-t"><span class="type">prelude_msg_t</span></a> object.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id392262"></a><h3>
<a name="prelude-msg-mark-end"></a>prelude_msg_mark_end ()</h3>
<a class="indexterm" name="id392274"></a><pre class="programlisting">void prelude_msg_mark_end (<a href="libprelude-prelude-msg.html#prelude-msg-t">prelude_msg_t</a> *msg);</pre>
<p>
Mark end of message in the <i class="parameter"><tt>msg</tt></i> buffer, so you can continue
adding different message in the same buffer.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><i class="parameter"><tt>msg</tt></i> :</span></td>
<td> Pointer on <a href="libprelude-prelude-msg.html#prelude-msg-t"><span class="type">prelude_msg_t</span></a> object.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id392336"></a><h3>
<a name="prelude-msg-dynamic-new"></a>prelude_msg_dynamic_new ()</h3>
<a class="indexterm" name="id392348"></a><pre class="programlisting">int prelude_msg_dynamic_new (<a href="libprelude-prelude-msg.html#prelude-msg-t">prelude_msg_t</a> **ret,
int (*flush_msg_cb) (prelude_msg_t **msg, void *data),
void *data);</pre>
<p>
Allocate a new <a href="libprelude-prelude-msg.html#prelude-msg-t"><span class="type">prelude_msg_t</span></a> object. <a href="libprelude-prelude-msg.html#prelude-msg-set"><tt class="function">prelude_msg_set()</tt></a> can then be used to
add chunk of data to the message, and <tt class="function">prelude_msg_mark_start()</tt> to separate
different message in the same buffer.
</p>
<p>
This function use memory chunk of static size to store the message in. If
the size of the data you want to store is bigger than the actual chunk size,
<i class="parameter"><tt>flush_msg_cb</tt></i> callback will be called for the current message to be flushed,
and the returned message will be used in order to store remaining data.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><i class="parameter"><tt>ret</tt></i> :</span></td>
<td> Pointer where to store the create <a href="libprelude-prelude-msg.html#prelude-msg-t"><span class="type">prelude_msg_t</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>flush_msg_cb</tt></i> :</span></td>
<td> Callback function to call when the buffer need to be flushed.
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>data</tt></i> :</span></td>
<td> Data to pass to the <i class="parameter"><tt>flush_msg_cb</tt></i> callback function.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> 0 on success, a negative value if an error occured.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id396354"></a><h3>
<a name="prelude-msg-new"></a>prelude_msg_new ()</h3>
<a class="indexterm" name="id396366"></a><pre class="programlisting">int prelude_msg_new (<a href="libprelude-prelude-msg.html#prelude-msg-t">prelude_msg_t</a> **ret,
size_t msgcount,
size_t msglen,
<a href="libprelude-prelude-inttypes.html#uint8-t">uint8_t</a> tag,
<a href="libprelude-prelude-msg.html#prelude-msg-priority-t">prelude_msg_priority_t</a> priority);</pre>
<p>
Allocate a new <a href="libprelude-prelude-msg.html#prelude-msg-t"><span class="type">prelude_msg_t</span></a> object and store it into <i class="parameter"><tt>ret</tt></i>. <a href="libprelude-prelude-msg.html#prelude-msg-set"><tt class="function">prelude_msg_set()</tt></a>
can then be used to add chunk of data to the message, and <a href="libprelude-prelude-msg.html#prelude-msg-write"><tt class="function">prelude_msg_write()</tt></a>
to send it.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><i class="parameter"><tt>ret</tt></i> :</span></td>
<td> Pointer where to store the created <a href="libprelude-prelude-msg.html#prelude-msg-t"><span class="type">prelude_msg_t</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>msgcount</tt></i> :</span></td>
<td> Number of chunk of data the created object can accept.
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>msglen</tt></i> :</span></td>
<td> Maximum number of bytes the object should handle for all the chunks.
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>tag</tt></i> :</span></td>
<td> A tag identifying the kind of message.
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>priority</tt></i> :</span></td>
<td> The priority of this message.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> 0 on success, a negative value if an error occured.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id392553"></a><h3>
<a name="prelude-msg-set"></a>prelude_msg_set ()</h3>
<a class="indexterm" name="id392565"></a><pre class="programlisting">int prelude_msg_set (<a href="libprelude-prelude-msg.html#prelude-msg-t">prelude_msg_t</a> *msg,
<a href="libprelude-prelude-inttypes.html#uint8-t">uint8_t</a> tag,
<a href="libprelude-prelude-inttypes.html#uint32-t">uint32_t</a> len,
const void *data);</pre>
<p>
<a href="libprelude-prelude-msg.html#prelude-msg-set"><tt class="function">prelude_msg_set()</tt></a> append <i class="parameter"><tt>len</tt></i> bytes of data from the <i class="parameter"><tt>data</tt></i> buffer
to the <i class="parameter"><tt>msg</tt></i> object representing a message. The data is tagged with <i class="parameter"><tt>tag</tt></i>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><i class="parameter"><tt>msg</tt></i> :</span></td>
<td> Pointer on a <a href="libprelude-prelude-msg.html#prelude-msg-t"><span class="type">prelude_msg_t</span></a> object to store the data to.
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>tag</tt></i> :</span></td>
<td> 8 bits unsigned integer describing the kind of data.
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>len</tt></i> :</span></td>
<td> len of the data chunk.
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>data</tt></i> :</span></td>
<td> Pointer to the starting address of the data.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> 0 on success, or a negative value if the remaining space is not
available. You might check the return value mostly if using a dynamic message
through <a href="libprelude-prelude-msg.html#prelude-msg-dynamic-new"><tt class="function">prelude_msg_dynamic_new()</tt></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id366157"></a><h3>
<a name="prelude-msg-write"></a>prelude_msg_write ()</h3>
<a class="indexterm" name="id366169"></a><pre class="programlisting">int prelude_msg_write (<a href="libprelude-prelude-msg.html#prelude-msg-t">prelude_msg_t</a> *msg,
<a href="libprelude-prelude-io.html#prelude-io-t">prelude_io_t</a> *dst);</pre>
<p>
<a href="libprelude-prelude-msg.html#prelude-msg-write"><tt class="function">prelude_msg_write()</tt></a> write the message corresponding to the <i class="parameter"><tt>msg</tt></i>
object to <i class="parameter"><tt>dst</tt></i>. The message should have been created using the
<a href="libprelude-prelude-msg.html#prelude-msg-new"><tt class="function">prelude_msg_new()</tt></a> and <a href="libprelude-prelude-msg.html#prelude-msg-set"><tt class="function">prelude_msg_set()</tt></a> functions.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><i class="parameter"><tt>msg</tt></i> :</span></td>
<td> Pointer on a <a href="libprelude-prelude-msg.html#prelude-msg-t"><span class="type">prelude_msg_t</span></a> object containing the message.
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>dst</tt></i> :</span></td>
<td> Pointer on a <a href="libprelude-prelude-io.html#prelude-io-t"><span class="type">prelude_io_t</span></a> object to send the message to.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> 0 on success, or a negative value if an error occured.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id366302"></a><h3>
<a name="prelude-msg-set-tag"></a>prelude_msg_set_tag ()</h3>
<a class="indexterm" name="id366314"></a><pre class="programlisting">void prelude_msg_set_tag (<a href="libprelude-prelude-msg.html#prelude-msg-t">prelude_msg_t</a> *msg,
<a href="libprelude-prelude-inttypes.html#uint8-t">uint8_t</a> tag);</pre>
<p>
Tag <i class="parameter"><tt>msg</tt></i>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><i class="parameter"><tt>msg</tt></i> :</span></td>
<td> Pointer on a <a href="libprelude-prelude-msg.html#prelude-msg-t"><span class="type">prelude_msg_t</span></a> object.
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>tag</tt></i> :</span></td>
<td> Tag to associate with <i class="parameter"><tt>msg</tt></i>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id359192"></a><h3>
<a name="prelude-msg-set-priority"></a>prelude_msg_set_priority ()</h3>
<a class="indexterm" name="id359204"></a><pre class="programlisting">void prelude_msg_set_priority (<a href="libprelude-prelude-msg.html#prelude-msg-t">prelude_msg_t</a> *msg,
<a href="libprelude-prelude-msg.html#prelude-msg-priority-t">prelude_msg_priority_t</a> priority);</pre>
<p>
Associate <i class="parameter"><tt>priority</tt></i> with <i class="parameter"><tt>msg</tt></i>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><i class="parameter"><tt>msg</tt></i> :</span></td>
<td> Pointer on a <a href="libprelude-prelude-msg.html#prelude-msg-t"><span class="type">prelude_msg_t</span></a> object.
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>priority</tt></i> :</span></td>
<td> Priority to associate with <i class="parameter"><tt>msg</tt></i>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id359298"></a><h3>
<a name="prelude-msg-get-tag"></a>prelude_msg_get_tag ()</h3>
<a class="indexterm" name="id359310"></a><pre class="programlisting"><a href="libprelude-prelude-inttypes.html#uint8-t">uint8_t</a> prelude_msg_get_tag (<a href="libprelude-prelude-msg.html#prelude-msg-t">prelude_msg_t</a> *msg);</pre>
<p>
<a href="libprelude-prelude-msg.html#prelude-msg-get-tag"><tt class="function">prelude_msg_get_tag()</tt></a> return the tag contained in the <i class="parameter"><tt>msg</tt></i> header.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><i class="parameter"><tt>msg</tt></i> :</span></td>
<td> Pointer on a <a href="libprelude-prelude-msg.html#prelude-msg-t"><span class="type">prelude_msg_t</span></a> object.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A tag.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id387361"></a><h3>
<a name="prelude-msg-get-priority"></a>prelude_msg_get_priority ()</h3>
<a class="indexterm" name="id387374"></a><pre class="programlisting"><a href="libprelude-prelude-msg.html#prelude-msg-priority-t">prelude_msg_priority_t</a> prelude_msg_get_priority
(<a href="libprelude-prelude-msg.html#prelude-msg-t">prelude_msg_t</a> *msg);</pre>
<p>
<a href="libprelude-prelude-msg.html#prelude-msg-get-priority"><tt class="function">prelude_msg_get_priority()</tt></a> return the priority contained in the <i class="parameter"><tt>msg</tt></i> header.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><i class="parameter"><tt>msg</tt></i> :</span></td>
<td> Pointer on a <a href="libprelude-prelude-msg.html#prelude-msg-t"><span class="type">prelude_msg_t</span></a> object.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A priority.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id387456"></a><h3>
<a name="prelude-msg-get-len"></a>prelude_msg_get_len ()</h3>
<a class="indexterm" name="id387468"></a><pre class="programlisting"><a href="libprelude-prelude-inttypes.html#uint32-t">uint32_t</a> prelude_msg_get_len (<a href="libprelude-prelude-msg.html#prelude-msg-t">prelude_msg_t</a> *msg);</pre>
<p>
<a href="libprelude-prelude-msg.html#prelude-msg-get-len"><tt class="function">prelude_msg_get_len()</tt></a> return the currently used
len for the <i class="parameter"><tt>msg</tt></i> message.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><i class="parameter"><tt>msg</tt></i> :</span></td>
<td> Pointer on a <a href="libprelude-prelude-msg.html#prelude-msg-t"><span class="type">prelude_msg_t</span></a> object.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> Len of the message.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id387550"></a><h3>
<a name="prelude-msg-get-datalen"></a>prelude_msg_get_datalen ()</h3>
<a class="indexterm" name="id387562"></a><pre class="programlisting"><a href="libprelude-prelude-inttypes.html#uint32-t">uint32_t</a> prelude_msg_get_datalen (<a href="libprelude-prelude-msg.html#prelude-msg-t">prelude_msg_t</a> *msg);</pre>
<p>
<a href="libprelude-prelude-msg.html#prelude-msg-get-datalen"><tt class="function">prelude_msg_get_datalen()</tt></a> return the len of the whole message
contained in the <i class="parameter"><tt>msg</tt></i> header.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><i class="parameter"><tt>msg</tt></i> :</span></td>
<td> Pointer on a <a href="libprelude-prelude-msg.html#prelude-msg-t"><span class="type">prelude_msg_t</span></a> object.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> Len of the message.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id399652"></a><h2>See Also</h2>
<p>
prelude-msgbuf
</p>
</div>
</div>
</body>
</html>
|
