← Back to branch summary

~ubuntu-branches/ubuntu/trusty/libprelude/trusty

« back to all changes in this revision

Viewing changes to docs/api/xml/prelude-msg.xml

  • Committer: Bazaar Package Importer
  • Author(s): Alessio Treglia
  • Date: 2009-07-13 10:19:39 UTC
  • mfrom: (1.1.14 upstream) (2.3.1 sid)
  • Revision ID: james.westby@ubuntu.com-20090713101939-5qlosl9xkv0jn2a0
Tags: 0.9.24-1ubuntu1
* Merge from debian unstable, Ubuntu remaining changes:
  - debian/control: Replace libltdl3-dev with libltdl7-dev in the
    Build-Depends field.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/api/xml/prelude-msg.xml
11
11
<refnamediv>
12
12
<refname>prelude-msg</refname>
13
13
<refpurpose>Prelude Messaging API</refpurpose>
14
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
15
14
</refnamediv>
16
15
 
17
16
<refsynopsisdiv id="libprelude-prelude-msg.synopsis" role="synopsis">
50
49
<link linkend="void">void</link>                <link linkend="prelude-msg-set-priority">prelude_msg_set_priority</link>            (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg,
51
50
                                                         <link linkend="prelude-msg-priority-t">prelude_msg_priority_t</link> priority);
52
51
<link linkend="uint8-t">uint8_t</link>             <link linkend="prelude-msg-get-tag">prelude_msg_get_tag</link>                 (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);
53
 
<link linkend="prelude-msg-priority-t">prelude_msg_priority_t</link> <link linkend="prelude-msg-get-priority">prelude_msg_get_priority</link>         (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);
 
52
<link linkend="prelude-msg-priority-t">prelude_msg_priority_t</link>  <link linkend="prelude-msg-get-priority">prelude_msg_get_priority</link>        (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);
54
53
<link linkend="uint32-t">uint32_t</link>            <link linkend="prelude-msg-get-len">prelude_msg_get_len</link>                 (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);
55
54
<link linkend="uint32-t">uint32_t</link>            <link linkend="prelude-msg-get-datalen">prelude_msg_get_datalen</link>             (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);
56
55
<link linkend="void">void</link>                <link linkend="prelude-msg-destroy">prelude_msg_destroy</link>                 (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);
57
 
struct <link linkend="timeval">timeval</link>*     <link linkend="prelude-msg-get-time">prelude_msg_get_time</link>                (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg,
 
56
struct <link linkend="timeval">timeval</link> *    <link linkend="prelude-msg-get-time">prelude_msg_get_time</link>                (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg,
58
57
                                                         <link linkend="struct-timeval">struct timeval</link> *tv);
59
58
<link linkend="int">int</link>                 <link linkend="prelude-msg-is-empty">prelude_msg_is_empty</link>                (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);
60
59
<link linkend="int">int</link>                 <link linkend="prelude-msg-is-fragment">prelude_msg_is_fragment</link>             (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);
61
 
<link linkend="prelude-msg-t">prelude_msg_t</link>*      <link linkend="prelude-msg-ref">prelude_msg_ref</link>                     (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);
 
60
<link linkend="prelude-msg-t">prelude_msg_t</link> *     <link linkend="prelude-msg-ref">prelude_msg_ref</link>                     (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);
62
61
<link linkend="void">void</link>                <link linkend="prelude-msg-set-callback">prelude_msg_set_callback</link>            (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg,
63
62
                                                         <link linkend="int">int</link> (flush_msg_cbprelude_msg_t **msg, void *data) ());
64
63
<link linkend="void">void</link>                <link linkend="prelude-msg-set-data">prelude_msg_set_data</link>                (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg,
65
64
                                                         <link linkend="void">void</link> *data);
66
 
const unsigned <link linkend="char">char</link>* <link linkend="prelude-msg-get-message-data">prelude_msg_get_message_data</link>       (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);
 
65
const unsigned <link linkend="char">char</link> * <link linkend="prelude-msg-get-message-data">prelude_msg_get_message_data</link>      (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);
67
66
</synopsis>
68
67
</refsynopsisdiv>
69
68
 
82
81
together. It feature compatibility between version, and use a way to describe
83
82
data similar to XML.
84
83
</para>
85
 
 
86
84
<para>
87
85
The Message header contain the protocol version, which is only to be used
88
 
in case the main protocol structure change (compatibility break), The tag 
89
 
describe the kind of message, The fragment field may be used if a message 
90
 
is sent in several time, The priority may be used by the receiving end 
91
 
to priorityze task, The datalen contain the size of the whole message in 
 
86
in case the main protocol structure change (compatibility break), The tag
 
87
describe the kind of message, The fragment field may be used if a message
 
88
is sent in several time, The priority may be used by the receiving end
 
89
to priorityze task, The datalen contain the size of the whole message in
92
90
network byte order
93
 
 
94
91
<programlisting>
95
 
 
96
92
   8bits    8bits   8bits     8bits                32bits
97
93
+--------+--------+--------+----------+------------------------------+
98
94
|version |   tag  |priority| fragment |            datalen           |
99
95
+--------+--------+--------+----------+------------------------------+
100
 
 
101
96
</programlisting>
102
97
</para>
103
 
 
104
 
 
105
98
<para>
106
99
Then the message itself contain submessage composed of :
107
 
 
108
100
A tag describing the kind of payload, the len of the payload (in network byte order),
109
 
the payload itself, and an end of message byte (0xff) in order to resynchronize in 
 
101
the payload itself, and an end of message byte (0xff) in order to resynchronize in
110
102
case of problem.
111
 
 
112
103
<programlisting>
113
 
 
114
104
  8bits              32bits                                   8bits
115
105
+--------+--------------------------------+-----------------+--------+
116
 
|  tag   |             len                |     payload     |  0xff  |                     
 
106
|  tag   |             len                |     payload     |  0xff  |
117
107
+--------+--------------------------------+-----------------+--------+
118
 
 
119
108
</programlisting>
120
109
</para>
121
110
</refsect1>
124
113
<title role="details.title">Details</title>
125
114
<refsect2 id="prelude-msg-t" role="typedef">
126
115
<title>prelude_msg_t</title>
127
 
<indexterm zone="prelude-msg-t"><primary>prelude_msg_t</primary></indexterm><programlisting>typedef struct prelude_msg prelude_msg_t;
 
116
<indexterm zone="prelude-msg-t"><primary sortas="prelude_msg_t">prelude_msg_t</primary></indexterm><programlisting>typedef struct prelude_msg prelude_msg_t;
128
117
</programlisting>
129
118
<para>
130
 
 
131
119
</para></refsect2>
132
120
<refsect2 id="prelude-msg-priority-t" role="enum">
133
121
<title>enum prelude_msg_priority_t</title>
134
 
<indexterm zone="prelude-msg-priority-t"><primary>prelude_msg_priority_t</primary></indexterm><programlisting>typedef enum {
 
122
<indexterm zone="prelude-msg-priority-t"><primary sortas="prelude_msg_priority_t">prelude_msg_priority_t</primary></indexterm><programlisting>typedef enum {
135
123
        PRELUDE_MSG_PRIORITY_NONE = 0,
136
124
        PRELUDE_MSG_PRIORITY_LOW  = 1,
137
125
        PRELUDE_MSG_PRIORITY_MID  = 2,
139
127
} prelude_msg_priority_t;
140
128
</programlisting>
141
129
<para>
142
 
 
143
130
</para></refsect2>
144
131
<refsect2 id="prelude-msg-read" role="function">
145
132
<title>prelude_msg_read ()</title>
146
 
<indexterm zone="prelude-msg-read"><primary>prelude_msg_read</primary></indexterm><programlisting><link linkend="int">int</link>                 prelude_msg_read                    (<link linkend="prelude-msg-t">prelude_msg_t</link> **msg,
 
133
<indexterm zone="prelude-msg-read"><primary sortas="prelude_msg_read">prelude_msg_read</primary></indexterm><programlisting><link linkend="int">int</link>                 prelude_msg_read                    (<link linkend="prelude-msg-t">prelude_msg_t</link> **msg,
147
134
                                                         <link linkend="prelude-io-t">prelude_io_t</link> *pio);</programlisting>
148
135
<para>
149
136
Read a message on <parameter>pio</parameter> into <parameter>msg</parameter>. If <parameter>msg</parameter> is NULL, it is
150
137
allocated. This function will never block.</para>
151
138
<para>
152
 
 
153
139
</para><variablelist role="params">
154
 
<varlistentry><term><parameter>msg</parameter>&nbsp;:</term>
 
140
<varlistentry><term><parameter>msg</parameter>&#160;:</term>
155
141
<listitem><simpara> Pointer on a <link linkend="prelude-msg-t"><type>prelude_msg_t</type></link> object address.
156
142
</simpara></listitem></varlistentry>
157
 
<varlistentry><term><parameter>pio</parameter>&nbsp;:</term>
 
143
<varlistentry><term><parameter>pio</parameter>&#160;:</term>
158
144
<listitem><simpara> Pointer on a <link linkend="prelude-io-t"><type>prelude_io_t</type></link> object.
159
145
</simpara></listitem></varlistentry>
160
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> 0 if reading the message is complete, or a <link linkend="prelude-error-t"><type>prelude_error_t</type></link>
161
 
error if an error occured. Take particular attention to <link linkend="PRELUDE-ERROR-EAGAIN:CAPS"><type>PRELUDE_ERROR_EAGAIN</type></link>
 
146
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> 0 if reading the message is complete, or a <link linkend="prelude-error-t"><type>prelude_error_t</type></link>
 
147
error if an error occured. Take particular attention to <link linkend="PRELUDE-ERROR-EAGAIN--CAPS"><type>PRELUDE_ERROR_EAGAIN</type></link>
162
148
and PRELUDE_ERROR_EOF.
163
149
</simpara></listitem></varlistentry>
164
150
</variablelist></refsect2>
165
151
<refsect2 id="prelude-msg-forward" role="function">
166
152
<title>prelude_msg_forward ()</title>
167
 
<indexterm zone="prelude-msg-forward"><primary>prelude_msg_forward</primary></indexterm><programlisting><link linkend="int">int</link>                 prelude_msg_forward                 (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg,
 
153
<indexterm zone="prelude-msg-forward"><primary sortas="prelude_msg_forward">prelude_msg_forward</primary></indexterm><programlisting><link linkend="int">int</link>                 prelude_msg_forward                 (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg,
168
154
                                                         <link linkend="prelude-io-t">prelude_io_t</link> *dst,
169
155
                                                         <link linkend="prelude-io-t">prelude_io_t</link> *src);</programlisting>
170
156
<para>
172
158
containing the message header previously gathered using <link linkend="prelude-msg-read-header"><function>prelude_msg_read_header()</function></link>
173
159
from the <parameter>src</parameter> object, and transfer it to <parameter>dst</parameter>. The header is also transfered.</para>
174
160
<para>
175
 
 
176
161
</para><variablelist role="params">
177
 
<varlistentry><term><parameter>msg</parameter>&nbsp;:</term>
 
162
<varlistentry><term><parameter>msg</parameter>&#160;:</term>
178
163
<listitem><simpara> Pointer on a <link linkend="prelude-msg-t"><type>prelude_msg_t</type></link> object containing a message header.
179
164
</simpara></listitem></varlistentry>
180
 
<varlistentry><term><parameter>dst</parameter>&nbsp;:</term>
 
165
<varlistentry><term><parameter>dst</parameter>&#160;:</term>
181
166
<listitem><simpara> Pointer on a <link linkend="prelude-io-t"><type>prelude_io_t</type></link> object to send message to.
182
167
</simpara></listitem></varlistentry>
183
 
<varlistentry><term><parameter>src</parameter>&nbsp;:</term>
 
168
<varlistentry><term><parameter>src</parameter>&#160;:</term>
184
169
<listitem><simpara> Pointer on a <link linkend="prelude-io-t"><type>prelude_io_t</type></link> object to read message from.
185
170
</simpara></listitem></varlistentry>
186
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> 0 on success, or a negative value if an error occured.
 
171
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> 0 on success, or a negative value if an error occured.
187
172
</simpara></listitem></varlistentry>
188
173
</variablelist></refsect2>
189
174
<refsect2 id="prelude-msg-get" role="function">
190
175
<title>prelude_msg_get ()</title>
191
 
<indexterm zone="prelude-msg-get"><primary>prelude_msg_get</primary></indexterm><programlisting><link linkend="int">int</link>                 prelude_msg_get                     (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg,
 
176
<indexterm zone="prelude-msg-get"><primary sortas="prelude_msg_get">prelude_msg_get</primary></indexterm><programlisting><link linkend="int">int</link>                 prelude_msg_get                     (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg,
192
177
                                                         <link linkend="uint8-t">uint8_t</link> *tag,
193
178
                                                         <link linkend="uint32-t">uint32_t</link> *len,
194
179
                                                         <link linkend="void">void</link> **buf);</programlisting>
198
183
<parameter>len</parameter> is updated to contain the len of the data chunk.
199
184
<parameter>buf</parameter> is updated to point on the data chunk.</para>
200
185
<para>
201
 
 
202
186
</para><variablelist role="params">
203
 
<varlistentry><term><parameter>msg</parameter>&nbsp;:</term>
 
187
<varlistentry><term><parameter>msg</parameter>&#160;:</term>
204
188
<listitem><simpara> Pointer on a <link linkend="prelude-msg-t"><type>prelude_msg_t</type></link> object representing the message to get data from.
205
189
</simpara></listitem></varlistentry>
206
 
<varlistentry><term><parameter>tag</parameter>&nbsp;:</term>
 
190
<varlistentry><term><parameter>tag</parameter>&#160;:</term>
207
191
<listitem><simpara> Pointer on a 8 bits unsigned integer to store the message tag.
208
192
</simpara></listitem></varlistentry>
209
 
<varlistentry><term><parameter>len</parameter>&nbsp;:</term>
 
193
<varlistentry><term><parameter>len</parameter>&#160;:</term>
210
194
<listitem><simpara> Pointer on a 32 bits unsigned integer to store the message len to.
211
195
</simpara></listitem></varlistentry>
212
 
<varlistentry><term><parameter>buf</parameter>&nbsp;:</term>
 
196
<varlistentry><term><parameter>buf</parameter>&#160;:</term>
213
197
<listitem><simpara> Address of a pointer to store the buffer starting address.
214
198
</simpara></listitem></varlistentry>
215
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> 0 on success, or a <link linkend="prelude-error-t"><type>prelude_error_t</type></link> value on error.
 
199
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> 0 on success, or a <link linkend="prelude-error-t"><type>prelude_error_t</type></link> value on error.
216
200
</simpara></listitem></varlistentry>
217
201
</variablelist></refsect2>
218
202
<refsect2 id="prelude-msg-recycle" role="function">
219
203
<title>prelude_msg_recycle ()</title>
220
 
<indexterm zone="prelude-msg-recycle"><primary>prelude_msg_recycle</primary></indexterm><programlisting><link linkend="void">void</link>                prelude_msg_recycle                 (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);</programlisting>
 
204
<indexterm zone="prelude-msg-recycle"><primary sortas="prelude_msg_recycle">prelude_msg_recycle</primary></indexterm><programlisting><link linkend="void">void</link>                prelude_msg_recycle                 (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);</programlisting>
221
205
<para>
222
206
Recycle <parameter>msg</parameter> so you can write at it again, even
223
207
thought it was written.</para>
224
208
<para>
225
 
 
226
209
</para><variablelist role="params">
227
 
<varlistentry><term><parameter>msg</parameter>&nbsp;:</term>
 
210
<varlistentry><term><parameter>msg</parameter>&#160;:</term>
228
211
<listitem><simpara> Pointer on <link linkend="prelude-msg-t"><type>prelude_msg_t</type></link> object.
229
212
</simpara></listitem></varlistentry>
230
213
</variablelist></refsect2>
231
214
<refsect2 id="prelude-msg-mark-end" role="function">
232
215
<title>prelude_msg_mark_end ()</title>
233
 
<indexterm zone="prelude-msg-mark-end"><primary>prelude_msg_mark_end</primary></indexterm><programlisting><link linkend="void">void</link>                prelude_msg_mark_end                (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);</programlisting>
 
216
<indexterm zone="prelude-msg-mark-end"><primary sortas="prelude_msg_mark_end">prelude_msg_mark_end</primary></indexterm><programlisting><link linkend="void">void</link>                prelude_msg_mark_end                (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);</programlisting>
234
217
<para>
235
218
Mark end of message in the <parameter>msg</parameter> buffer, so you can continue
236
219
adding different message in the same buffer.</para>
237
220
<para>
238
 
 
239
221
</para><variablelist role="params">
240
 
<varlistentry><term><parameter>msg</parameter>&nbsp;:</term>
 
222
<varlistentry><term><parameter>msg</parameter>&#160;:</term>
241
223
<listitem><simpara> Pointer on <link linkend="prelude-msg-t"><type>prelude_msg_t</type></link> object.
242
224
</simpara></listitem></varlistentry>
243
225
</variablelist></refsect2>
244
226
<refsect2 id="prelude-msg-dynamic-new" role="function">
245
227
<title>prelude_msg_dynamic_new ()</title>
246
 
<indexterm zone="prelude-msg-dynamic-new"><primary>prelude_msg_dynamic_new</primary></indexterm><programlisting><link linkend="int">int</link>                 prelude_msg_dynamic_new             (<link linkend="prelude-msg-t">prelude_msg_t</link> **ret,
 
228
<indexterm zone="prelude-msg-dynamic-new"><primary sortas="prelude_msg_dynamic_new">prelude_msg_dynamic_new</primary></indexterm><programlisting><link linkend="int">int</link>                 prelude_msg_dynamic_new             (<link linkend="prelude-msg-t">prelude_msg_t</link> **ret,
247
229
                                                         <link linkend="int">int</link> (flush_msg_cbprelude_msg_t **msg, void *data) (),
248
230
                                                         <link linkend="void">void</link> *data);</programlisting>
249
231
<para>
257
239
<parameter>flush_msg_cb</parameter> callback will be called for the current message to be flushed,
258
240
and the returned message will be used in order to store remaining data.</para>
259
241
<para>
260
 
 
261
242
</para><variablelist role="params">
262
 
<varlistentry><term><parameter>ret</parameter>&nbsp;:</term>
 
243
<varlistentry><term><parameter>ret</parameter>&#160;:</term>
263
244
<listitem><simpara> Pointer where to store the create <link linkend="prelude-msg-t"><type>prelude_msg_t</type></link>.
264
245
</simpara></listitem></varlistentry>
265
 
<varlistentry><term><parameter>flush_msg_cb</parameter>&nbsp;:</term>
 
246
<varlistentry><term><parameter>flush_msg_cb</parameter>&#160;:</term>
266
247
<listitem><simpara> Callback function to call when the buffer need to be flushed.
267
248
</simpara></listitem></varlistentry>
268
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
249
<varlistentry><term><parameter>data</parameter>&#160;:</term>
269
250
<listitem><simpara> Data to pass to the <parameter>flush_msg_cb</parameter> callback function.
270
251
</simpara></listitem></varlistentry>
271
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> 0 on success, a negative value if an error occured.
 
252
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> 0 on success, a negative value if an error occured.
272
253
</simpara></listitem></varlistentry>
273
254
</variablelist></refsect2>
274
255
<refsect2 id="prelude-msg-new" role="function">
275
256
<title>prelude_msg_new ()</title>
276
 
<indexterm zone="prelude-msg-new"><primary>prelude_msg_new</primary></indexterm><programlisting><link linkend="int">int</link>                 prelude_msg_new                     (<link linkend="prelude-msg-t">prelude_msg_t</link> **ret,
 
257
<indexterm zone="prelude-msg-new"><primary sortas="prelude_msg_new">prelude_msg_new</primary></indexterm><programlisting><link linkend="int">int</link>                 prelude_msg_new                     (<link linkend="prelude-msg-t">prelude_msg_t</link> **ret,
277
258
                                                         <link linkend="size-t">size_t</link> msgcount,
278
259
                                                         <link linkend="size-t">size_t</link> msglen,
279
260
                                                         <link linkend="uint8-t">uint8_t</link> tag,
283
264
can then be used to add chunk of data to the message, and <link linkend="prelude-msg-write"><function>prelude_msg_write()</function></link>
284
265
to send it.</para>
285
266
<para>
286
 
 
287
267
</para><variablelist role="params">
288
 
<varlistentry><term><parameter>ret</parameter>&nbsp;:</term>
 
268
<varlistentry><term><parameter>ret</parameter>&#160;:</term>
289
269
<listitem><simpara> Pointer where to store the created <link linkend="prelude-msg-t"><type>prelude_msg_t</type></link>.
290
270
</simpara></listitem></varlistentry>
291
 
<varlistentry><term><parameter>msgcount</parameter>&nbsp;:</term>
 
271
<varlistentry><term><parameter>msgcount</parameter>&#160;:</term>
292
272
<listitem><simpara> Number of chunk of data the created object can accept.
293
273
</simpara></listitem></varlistentry>
294
 
<varlistentry><term><parameter>msglen</parameter>&nbsp;:</term>
 
274
<varlistentry><term><parameter>msglen</parameter>&#160;:</term>
295
275
<listitem><simpara> Maximum number of bytes the object should handle for all the chunks.
296
276
</simpara></listitem></varlistentry>
297
 
<varlistentry><term><parameter>tag</parameter>&nbsp;:</term>
 
277
<varlistentry><term><parameter>tag</parameter>&#160;:</term>
298
278
<listitem><simpara> A tag identifying the kind of message.
299
279
</simpara></listitem></varlistentry>
300
 
<varlistentry><term><parameter>priority</parameter>&nbsp;:</term>
 
280
<varlistentry><term><parameter>priority</parameter>&#160;:</term>
301
281
<listitem><simpara> The priority of this message.
302
282
</simpara></listitem></varlistentry>
303
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> 0 on success, a negative value if an error occured.
 
283
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> 0 on success, a negative value if an error occured.
304
284
</simpara></listitem></varlistentry>
305
285
</variablelist></refsect2>
306
286
<refsect2 id="prelude-msg-set" role="function">
307
287
<title>prelude_msg_set ()</title>
308
 
<indexterm zone="prelude-msg-set"><primary>prelude_msg_set</primary></indexterm><programlisting><link linkend="int">int</link>                 prelude_msg_set                     (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg,
 
288
<indexterm zone="prelude-msg-set"><primary sortas="prelude_msg_set">prelude_msg_set</primary></indexterm><programlisting><link linkend="int">int</link>                 prelude_msg_set                     (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg,
309
289
                                                         <link linkend="uint8-t">uint8_t</link> tag,
310
290
                                                         <link linkend="uint32-t">uint32_t</link> len,
311
291
                                                         const <link linkend="void">void</link> *data);</programlisting>
313
293
<link linkend="prelude-msg-set"><function>prelude_msg_set()</function></link> append <parameter>len</parameter> bytes of data from the <parameter>data</parameter> buffer
314
294
to the <parameter>msg</parameter> object representing a message. The data is tagged with <parameter>tag</parameter>.</para>
315
295
<para>
316
 
 
317
296
</para><variablelist role="params">
318
 
<varlistentry><term><parameter>msg</parameter>&nbsp;:</term>
 
297
<varlistentry><term><parameter>msg</parameter>&#160;:</term>
319
298
<listitem><simpara> Pointer on a <link linkend="prelude-msg-t"><type>prelude_msg_t</type></link> object to store the data to.
320
299
</simpara></listitem></varlistentry>
321
 
<varlistentry><term><parameter>tag</parameter>&nbsp;:</term>
 
300
<varlistentry><term><parameter>tag</parameter>&#160;:</term>
322
301
<listitem><simpara> 8 bits unsigned integer describing the kind of data.
323
302
</simpara></listitem></varlistentry>
324
 
<varlistentry><term><parameter>len</parameter>&nbsp;:</term>
 
303
<varlistentry><term><parameter>len</parameter>&#160;:</term>
325
304
<listitem><simpara> len of the data chunk.
326
305
</simpara></listitem></varlistentry>
327
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
306
<varlistentry><term><parameter>data</parameter>&#160;:</term>
328
307
<listitem><simpara> Pointer to the starting address of the data.
329
308
</simpara></listitem></varlistentry>
330
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> 0 on success, or a negative value if the remaining space is not
 
309
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> 0 on success, or a negative value if the remaining space is not
331
310
available. You might check the return value mostly if using a dynamic message
332
311
through <link linkend="prelude-msg-dynamic-new"><function>prelude_msg_dynamic_new()</function></link>
333
312
</simpara></listitem></varlistentry>
334
313
</variablelist></refsect2>
335
314
<refsect2 id="prelude-msg-write" role="function">
336
315
<title>prelude_msg_write ()</title>
337
 
<indexterm zone="prelude-msg-write"><primary>prelude_msg_write</primary></indexterm><programlisting><link linkend="int">int</link>                 prelude_msg_write                   (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg,
 
316
<indexterm zone="prelude-msg-write"><primary sortas="prelude_msg_write">prelude_msg_write</primary></indexterm><programlisting><link linkend="int">int</link>                 prelude_msg_write                   (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg,
338
317
                                                         <link linkend="prelude-io-t">prelude_io_t</link> *dst);</programlisting>
339
318
<para>
340
319
<link linkend="prelude-msg-write"><function>prelude_msg_write()</function></link> write the message corresponding to the <parameter>msg</parameter>
341
320
object to <parameter>dst</parameter>. The message should have been created using the
342
321
<link linkend="prelude-msg-new"><function>prelude_msg_new()</function></link> and <link linkend="prelude-msg-set"><function>prelude_msg_set()</function></link> functions.</para>
343
322
<para>
344
 
 
345
323
</para><variablelist role="params">
346
 
<varlistentry><term><parameter>msg</parameter>&nbsp;:</term>
 
324
<varlistentry><term><parameter>msg</parameter>&#160;:</term>
347
325
<listitem><simpara> Pointer on a <link linkend="prelude-msg-t"><type>prelude_msg_t</type></link> object containing the message.
348
326
</simpara></listitem></varlistentry>
349
 
<varlistentry><term><parameter>dst</parameter>&nbsp;:</term>
 
327
<varlistentry><term><parameter>dst</parameter>&#160;:</term>
350
328
<listitem><simpara> Pointer on a <link linkend="prelude-io-t"><type>prelude_io_t</type></link> object to send the message to.
351
329
</simpara></listitem></varlistentry>
352
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> 0 on success, or a negative value if an error occured.
 
330
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> 0 on success, or a negative value if an error occured.
353
331
</simpara></listitem></varlistentry>
354
332
</variablelist></refsect2>
355
333
<refsect2 id="prelude-msg-set-tag" role="function">
356
334
<title>prelude_msg_set_tag ()</title>
357
 
<indexterm zone="prelude-msg-set-tag"><primary>prelude_msg_set_tag</primary></indexterm><programlisting><link linkend="void">void</link>                prelude_msg_set_tag                 (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg,
 
335
<indexterm zone="prelude-msg-set-tag"><primary sortas="prelude_msg_set_tag">prelude_msg_set_tag</primary></indexterm><programlisting><link linkend="void">void</link>                prelude_msg_set_tag                 (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg,
358
336
                                                         <link linkend="uint8-t">uint8_t</link> tag);</programlisting>
359
337
<para>
360
338
Tag <parameter>msg</parameter>.</para>
361
339
<para>
362
 
 
363
340
</para><variablelist role="params">
364
 
<varlistentry><term><parameter>msg</parameter>&nbsp;:</term>
 
341
<varlistentry><term><parameter>msg</parameter>&#160;:</term>
365
342
<listitem><simpara> Pointer on a <link linkend="prelude-msg-t"><type>prelude_msg_t</type></link> object.
366
343
</simpara></listitem></varlistentry>
367
 
<varlistentry><term><parameter>tag</parameter>&nbsp;:</term>
 
344
<varlistentry><term><parameter>tag</parameter>&#160;:</term>
368
345
<listitem><simpara> Tag to associate with <parameter>msg</parameter>.
369
346
</simpara></listitem></varlistentry>
370
347
</variablelist></refsect2>
371
348
<refsect2 id="prelude-msg-set-priority" role="function">
372
349
<title>prelude_msg_set_priority ()</title>
373
 
<indexterm zone="prelude-msg-set-priority"><primary>prelude_msg_set_priority</primary></indexterm><programlisting><link linkend="void">void</link>                prelude_msg_set_priority            (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg,
 
350
<indexterm zone="prelude-msg-set-priority"><primary sortas="prelude_msg_set_priority">prelude_msg_set_priority</primary></indexterm><programlisting><link linkend="void">void</link>                prelude_msg_set_priority            (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg,
374
351
                                                         <link linkend="prelude-msg-priority-t">prelude_msg_priority_t</link> priority);</programlisting>
375
352
<para>
376
353
Associate <parameter>priority</parameter> with <parameter>msg</parameter>.</para>
377
354
<para>
378
 
 
379
355
</para><variablelist role="params">
380
 
<varlistentry><term><parameter>msg</parameter>&nbsp;:</term>
 
356
<varlistentry><term><parameter>msg</parameter>&#160;:</term>
381
357
<listitem><simpara> Pointer on a <link linkend="prelude-msg-t"><type>prelude_msg_t</type></link> object.
382
358
</simpara></listitem></varlistentry>
383
 
<varlistentry><term><parameter>priority</parameter>&nbsp;:</term>
 
359
<varlistentry><term><parameter>priority</parameter>&#160;:</term>
384
360
<listitem><simpara> Priority to associate with <parameter>msg</parameter>.
385
361
</simpara></listitem></varlistentry>
386
362
</variablelist></refsect2>
387
363
<refsect2 id="prelude-msg-get-tag" role="function">
388
364
<title>prelude_msg_get_tag ()</title>
389
 
<indexterm zone="prelude-msg-get-tag"><primary>prelude_msg_get_tag</primary></indexterm><programlisting><link linkend="uint8-t">uint8_t</link>             prelude_msg_get_tag                 (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);</programlisting>
 
365
<indexterm zone="prelude-msg-get-tag"><primary sortas="prelude_msg_get_tag">prelude_msg_get_tag</primary></indexterm><programlisting><link linkend="uint8-t">uint8_t</link>             prelude_msg_get_tag                 (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);</programlisting>
390
366
<para>
391
367
<link linkend="prelude-msg-get-tag"><function>prelude_msg_get_tag()</function></link> return the tag contained in the <parameter>msg</parameter> header.</para>
392
368
<para>
393
 
 
394
369
</para><variablelist role="params">
395
 
<varlistentry><term><parameter>msg</parameter>&nbsp;:</term>
 
370
<varlistentry><term><parameter>msg</parameter>&#160;:</term>
396
371
<listitem><simpara> Pointer on a <link linkend="prelude-msg-t"><type>prelude_msg_t</type></link> object.
397
372
</simpara></listitem></varlistentry>
398
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A tag.
 
373
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A tag.
399
374
</simpara></listitem></varlistentry>
400
375
</variablelist></refsect2>
401
376
<refsect2 id="prelude-msg-get-priority" role="function">
402
377
<title>prelude_msg_get_priority ()</title>
403
 
<indexterm zone="prelude-msg-get-priority"><primary>prelude_msg_get_priority</primary></indexterm><programlisting><link linkend="prelude-msg-priority-t">prelude_msg_priority_t</link> prelude_msg_get_priority         (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);</programlisting>
 
378
<indexterm zone="prelude-msg-get-priority"><primary sortas="prelude_msg_get_priority">prelude_msg_get_priority</primary></indexterm><programlisting><link linkend="prelude-msg-priority-t">prelude_msg_priority_t</link>  prelude_msg_get_priority        (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);</programlisting>
404
379
<para>
405
380
<link linkend="prelude-msg-get-priority"><function>prelude_msg_get_priority()</function></link> return the priority contained in the <parameter>msg</parameter> header.</para>
406
381
<para>
407
 
 
408
382
</para><variablelist role="params">
409
 
<varlistentry><term><parameter>msg</parameter>&nbsp;:</term>
 
383
<varlistentry><term><parameter>msg</parameter>&#160;:</term>
410
384
<listitem><simpara> Pointer on a <link linkend="prelude-msg-t"><type>prelude_msg_t</type></link> object.
411
385
</simpara></listitem></varlistentry>
412
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A priority.
 
386
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A priority.
413
387
</simpara></listitem></varlistentry>
414
388
</variablelist></refsect2>
415
389
<refsect2 id="prelude-msg-get-len" role="function">
416
390
<title>prelude_msg_get_len ()</title>
417
 
<indexterm zone="prelude-msg-get-len"><primary>prelude_msg_get_len</primary></indexterm><programlisting><link linkend="uint32-t">uint32_t</link>            prelude_msg_get_len                 (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);</programlisting>
 
391
<indexterm zone="prelude-msg-get-len"><primary sortas="prelude_msg_get_len">prelude_msg_get_len</primary></indexterm><programlisting><link linkend="uint32-t">uint32_t</link>            prelude_msg_get_len                 (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);</programlisting>
418
392
<para>
419
393
<link linkend="prelude-msg-get-len"><function>prelude_msg_get_len()</function></link> return the currently used
420
394
len for the <parameter>msg</parameter> message.</para>
421
395
<para>
422
 
 
423
396
</para><variablelist role="params">
424
 
<varlistentry><term><parameter>msg</parameter>&nbsp;:</term>
 
397
<varlistentry><term><parameter>msg</parameter>&#160;:</term>
425
398
<listitem><simpara> Pointer on a <link linkend="prelude-msg-t"><type>prelude_msg_t</type></link> object.
426
399
</simpara></listitem></varlistentry>
427
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> Len of the message.
 
400
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> Len of the message.
428
401
</simpara></listitem></varlistentry>
429
402
</variablelist></refsect2>
430
403
<refsect2 id="prelude-msg-get-datalen" role="function">
431
404
<title>prelude_msg_get_datalen ()</title>
432
 
<indexterm zone="prelude-msg-get-datalen"><primary>prelude_msg_get_datalen</primary></indexterm><programlisting><link linkend="uint32-t">uint32_t</link>            prelude_msg_get_datalen             (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);</programlisting>
 
405
<indexterm zone="prelude-msg-get-datalen"><primary sortas="prelude_msg_get_datalen">prelude_msg_get_datalen</primary></indexterm><programlisting><link linkend="uint32-t">uint32_t</link>            prelude_msg_get_datalen             (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);</programlisting>
433
406
<para>
434
407
<link linkend="prelude-msg-get-datalen"><function>prelude_msg_get_datalen()</function></link> return the len of the whole message
435
408
contained in the <parameter>msg</parameter> header.</para>
436
409
<para>
437
 
 
438
410
</para><variablelist role="params">
439
 
<varlistentry><term><parameter>msg</parameter>&nbsp;:</term>
 
411
<varlistentry><term><parameter>msg</parameter>&#160;:</term>
440
412
<listitem><simpara> Pointer on a <link linkend="prelude-msg-t"><type>prelude_msg_t</type></link> object.
441
413
</simpara></listitem></varlistentry>
442
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> Len of the message.
 
414
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> Len of the message.
443
415
</simpara></listitem></varlistentry>
444
416
</variablelist></refsect2>
445
417
<refsect2 id="prelude-msg-destroy" role="function">
446
418
<title>prelude_msg_destroy ()</title>
447
 
<indexterm zone="prelude-msg-destroy"><primary>prelude_msg_destroy</primary></indexterm><programlisting><link linkend="void">void</link>                prelude_msg_destroy                 (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);</programlisting>
 
419
<indexterm zone="prelude-msg-destroy"><primary sortas="prelude_msg_destroy">prelude_msg_destroy</primary></indexterm><programlisting><link linkend="void">void</link>                prelude_msg_destroy                 (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);</programlisting>
448
420
<para>
449
421
<link linkend="prelude-msg-destroy"><function>prelude_msg_destroy()</function></link> destroy the <link linkend="prelude-msg-t"><type>prelude_msg_t</type></link> object pointed
450
422
to by <parameter>msg</parameter>. All the ressources for this message are freed.</para>
451
423
<para>
452
 
 
453
424
</para><variablelist role="params">
454
 
<varlistentry><term><parameter>msg</parameter>&nbsp;:</term>
 
425
<varlistentry><term><parameter>msg</parameter>&#160;:</term>
455
426
<listitem><simpara> Pointer on a <link linkend="prelude-msg-t"><type>prelude_msg_t</type></link> object.
456
427
</simpara></listitem></varlistentry>
457
428
</variablelist></refsect2>
458
429
<refsect2 id="prelude-msg-get-time" role="function">
459
430
<title>prelude_msg_get_time ()</title>
460
 
<indexterm zone="prelude-msg-get-time"><primary>prelude_msg_get_time</primary></indexterm><programlisting>struct <link linkend="timeval">timeval</link>*     prelude_msg_get_time                (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg,
 
431
<indexterm zone="prelude-msg-get-time"><primary sortas="prelude_msg_get_time">prelude_msg_get_time</primary></indexterm><programlisting>struct <link linkend="timeval">timeval</link> *    prelude_msg_get_time                (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg,
461
432
                                                         <link linkend="struct-timeval">struct timeval</link> *tv);</programlisting>
462
433
<para>
463
 
 
464
434
</para><variablelist role="params">
465
 
<varlistentry><term><parameter>msg</parameter>&nbsp;:</term>
466
 
<listitem><simpara>
467
 
</simpara></listitem></varlistentry>
468
 
<varlistentry><term><parameter>tv</parameter>&nbsp;:</term>
469
 
<listitem><simpara>
470
 
</simpara></listitem></varlistentry>
471
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
472
 
 
473
 
 
 
435
<varlistentry><term><parameter>msg</parameter>&#160;:</term>
 
436
<listitem><simpara>
 
437
</simpara></listitem></varlistentry>
 
438
<varlistentry><term><parameter>tv</parameter>&#160;:</term>
 
439
<listitem><simpara>
 
440
</simpara></listitem></varlistentry>
 
441
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
474
442
</simpara></listitem></varlistentry>
475
443
</variablelist></refsect2>
476
444
<refsect2 id="prelude-msg-is-empty" role="function">
477
445
<title>prelude_msg_is_empty ()</title>
478
 
<indexterm zone="prelude-msg-is-empty"><primary>prelude_msg_is_empty</primary></indexterm><programlisting><link linkend="int">int</link>                 prelude_msg_is_empty                (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);</programlisting>
 
446
<indexterm zone="prelude-msg-is-empty"><primary sortas="prelude_msg_is_empty">prelude_msg_is_empty</primary></indexterm><programlisting><link linkend="int">int</link>                 prelude_msg_is_empty                (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);</programlisting>
479
447
<para>
480
448
</para>
481
449
<para>
482
 
 
483
450
</para><variablelist role="params">
484
 
<varlistentry><term><parameter>msg</parameter>&nbsp;:</term>
 
451
<varlistentry><term><parameter>msg</parameter>&#160;:</term>
485
452
<listitem><simpara> Pointer on a <link linkend="prelude-msg-t"><type>prelude_msg_t</type></link> object.
486
453
</simpara></listitem></varlistentry>
487
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> true if <parameter>msg</parameter> doesn't contain any data to send.
 
454
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> true if <parameter>msg</parameter> doesn't contain any data to send.
488
455
</simpara></listitem></varlistentry>
489
456
</variablelist></refsect2>
490
457
<refsect2 id="prelude-msg-is-fragment" role="function">
491
458
<title>prelude_msg_is_fragment ()</title>
492
 
<indexterm zone="prelude-msg-is-fragment"><primary>prelude_msg_is_fragment</primary></indexterm><programlisting><link linkend="int">int</link>                 prelude_msg_is_fragment             (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);</programlisting>
 
459
<indexterm zone="prelude-msg-is-fragment"><primary sortas="prelude_msg_is_fragment">prelude_msg_is_fragment</primary></indexterm><programlisting><link linkend="int">int</link>                 prelude_msg_is_fragment             (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);</programlisting>
493
460
<para>
494
461
</para>
495
462
<para>
496
 
 
497
463
</para><variablelist role="params">
498
 
<varlistentry><term><parameter>msg</parameter>&nbsp;:</term>
 
464
<varlistentry><term><parameter>msg</parameter>&#160;:</term>
499
465
<listitem><simpara> Pointer on a <link linkend="prelude-msg-t"><type>prelude_msg_t</type></link> object.
500
466
</simpara></listitem></varlistentry>
501
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> true if <parameter>msg</parameter> only contain a fragment of message.
 
467
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> true if <parameter>msg</parameter> only contain a fragment of message.
502
468
</simpara></listitem></varlistentry>
503
469
</variablelist></refsect2>
504
470
<refsect2 id="prelude-msg-ref" role="function">
505
471
<title>prelude_msg_ref ()</title>
506
 
<indexterm zone="prelude-msg-ref"><primary>prelude_msg_ref</primary></indexterm><programlisting><link linkend="prelude-msg-t">prelude_msg_t</link>*      prelude_msg_ref                     (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);</programlisting>
 
472
<indexterm zone="prelude-msg-ref"><primary sortas="prelude_msg_ref">prelude_msg_ref</primary></indexterm><programlisting><link linkend="prelude-msg-t">prelude_msg_t</link> *     prelude_msg_ref                     (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);</programlisting>
507
473
<para>
508
 
 
509
474
</para><variablelist role="params">
510
 
<varlistentry><term><parameter>msg</parameter>&nbsp;:</term>
 
475
<varlistentry><term><parameter>msg</parameter>&#160;:</term>
511
476
<listitem><simpara>
512
477
</simpara></listitem></varlistentry>
513
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
514
 
 
515
 
 
 
478
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
516
479
</simpara></listitem></varlistentry>
517
480
</variablelist></refsect2>
518
481
<refsect2 id="prelude-msg-set-callback" role="function">
519
482
<title>prelude_msg_set_callback ()</title>
520
 
<indexterm zone="prelude-msg-set-callback"><primary>prelude_msg_set_callback</primary></indexterm><programlisting><link linkend="void">void</link>                prelude_msg_set_callback            (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg,
 
483
<indexterm zone="prelude-msg-set-callback"><primary sortas="prelude_msg_set_callback">prelude_msg_set_callback</primary></indexterm><programlisting><link linkend="void">void</link>                prelude_msg_set_callback            (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg,
521
484
                                                         <link linkend="int">int</link> (flush_msg_cbprelude_msg_t **msg, void *data) ());</programlisting>
522
485
<para>
523
486
<link linkend="prelude-msg-set-callback"><function>prelude_msg_set_callback()</function></link> allow to change the callback used
524
487
to flush a message created with <link linkend="prelude-msg-dynamic-new"><function>prelude_msg_dynamic_new()</function></link>.</para>
525
488
<para>
526
 
 
527
489
</para><variablelist role="params">
528
 
<varlistentry><term><parameter>msg</parameter>&nbsp;:</term>
 
490
<varlistentry><term><parameter>msg</parameter>&#160;:</term>
529
491
<listitem><simpara> Pointer on a <link linkend="prelude-msg-t"><type>prelude_msg_t</type></link> object.
530
492
</simpara></listitem></varlistentry>
531
 
<varlistentry><term><parameter>flush_msg_cb</parameter>&nbsp;:</term>
 
493
<varlistentry><term><parameter>flush_msg_cb</parameter>&#160;:</term>
532
494
<listitem><simpara> Pointer on a function responssible of sending the message.
533
495
</simpara></listitem></varlistentry>
534
496
</variablelist></refsect2>
535
497
<refsect2 id="prelude-msg-set-data" role="function">
536
498
<title>prelude_msg_set_data ()</title>
537
 
<indexterm zone="prelude-msg-set-data"><primary>prelude_msg_set_data</primary></indexterm><programlisting><link linkend="void">void</link>                prelude_msg_set_data                (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg,
 
499
<indexterm zone="prelude-msg-set-data"><primary sortas="prelude_msg_set_data">prelude_msg_set_data</primary></indexterm><programlisting><link linkend="void">void</link>                prelude_msg_set_data                (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg,
538
500
                                                         <link linkend="void">void</link> *data);</programlisting>
539
501
<para>
540
502
<link linkend="prelude-msg-set-data"><function>prelude_msg_set_data()</function></link> allow to change the data passed
541
503
to the message sending callback.</para>
542
504
<para>
543
 
 
544
505
</para><variablelist role="params">
545
 
<varlistentry><term><parameter>msg</parameter>&nbsp;:</term>
 
506
<varlistentry><term><parameter>msg</parameter>&#160;:</term>
546
507
<listitem><simpara> Pointer on a <link linkend="prelude-msg-t"><type>prelude_msg_t</type></link> object.
547
508
</simpara></listitem></varlistentry>
548
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
509
<varlistentry><term><parameter>data</parameter>&#160;:</term>
549
510
<listitem><simpara> Pointer on the data to associate to this message.
550
511
</simpara></listitem></varlistentry>
551
512
</variablelist></refsect2>
552
513
<refsect2 id="prelude-msg-get-message-data" role="function">
553
514
<title>prelude_msg_get_message_data ()</title>
554
 
<indexterm zone="prelude-msg-get-message-data"><primary>prelude_msg_get_message_data</primary></indexterm><programlisting>const unsigned <link linkend="char">char</link>* prelude_msg_get_message_data       (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);</programlisting>
 
515
<indexterm zone="prelude-msg-get-message-data"><primary sortas="prelude_msg_get_message_data">prelude_msg_get_message_data</primary></indexterm><programlisting>const unsigned <link linkend="char">char</link> * prelude_msg_get_message_data      (<link linkend="prelude-msg-t">prelude_msg_t</link> *msg);</programlisting>
555
516
<para>
556
 
 
557
517
</para><variablelist role="params">
558
 
<varlistentry><term><parameter>msg</parameter>&nbsp;:</term>
 
518
<varlistentry><term><parameter>msg</parameter>&#160;:</term>
559
519
<listitem><simpara>
560
520
</simpara></listitem></varlistentry>
561
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
562
 
 
563
 
 
 
521
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
564
522
</simpara></listitem></varlistentry>
565
523
</variablelist></refsect2>
566
524