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
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libprelude-prelude-msgbuf">
<refmeta>
<refentrytitle id="top_of_page">prelude-msgbuf</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBPRELUDE Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>prelude-msgbuf</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="synopsis">
<title id="synopsis.title">Synopsis</title>
<synopsis>
typedef <link linkend="prelude-msgbuf-t">prelude_msgbuf_t</link>;
enum <link linkend="prelude-msgbuf-flags-t">prelude_msgbuf_flags_t</link>;
<link linkend="int">int</link> <link linkend="prelude-msgbuf-new">prelude_msgbuf_new</link> (<link linkend="prelude-msgbuf-t">prelude_msgbuf_t</link> **msgbuf);
<link linkend="void">void</link> <link linkend="prelude-msgbuf-destroy">prelude_msgbuf_destroy</link> (<link linkend="prelude-msgbuf-t">prelude_msgbuf_t</link> *msgbuf);
<link linkend="void">void</link> <link linkend="prelude-msgbuf-mark-end">prelude_msgbuf_mark_end</link> (<link linkend="prelude-msgbuf-t">prelude_msgbuf_t</link> *msgbuf);
<link linkend="int">int</link> <link linkend="prelude-msgbuf-set">prelude_msgbuf_set</link> (<link linkend="prelude-msgbuf-t">prelude_msgbuf_t</link> *msgbuf,
<link linkend="uint8-t">uint8_t</link> tag,
<link linkend="uint32-t">uint32_t</link> len,
const <link linkend="void">void</link> *data);
<link linkend="prelude-msg-t">prelude_msg_t</link>* <link linkend="prelude-msgbuf-get-msg">prelude_msgbuf_get_msg</link> (<link linkend="prelude-msgbuf-t">prelude_msgbuf_t</link> *msgbuf);
<link linkend="void">void</link> <link linkend="prelude-msgbuf-set-callback">prelude_msgbuf_set_callback</link> (<link linkend="prelude-msgbuf-t">prelude_msgbuf_t</link> *msgbuf,
<link linkend="int">int</link> (*send_msg) (prelude_msgbuf_t *msgbuf, prelude_msg_t *msg));
<link linkend="void">void</link> <link linkend="prelude-msgbuf-set-data">prelude_msgbuf_set_data</link> (<link linkend="prelude-msgbuf-t">prelude_msgbuf_t</link> *msgbuf,
<link linkend="void">void</link> *data);
<link linkend="void">void</link>* <link linkend="prelude-msgbuf-get-data">prelude_msgbuf_get_data</link> (<link linkend="prelude-msgbuf-t">prelude_msgbuf_t</link> *msgbuf);
<link linkend="void">void</link> <link linkend="prelude-msgbuf-set-flags">prelude_msgbuf_set_flags</link> (<link linkend="prelude-msgbuf-t">prelude_msgbuf_t</link> *msgbuf,
<link linkend="prelude-msgbuf-flags-t">prelude_msgbuf_flags_t</link> flags);
<link linkend="prelude-msgbuf-flags-t">prelude_msgbuf_flags_t</link> <link linkend="prelude-msgbuf-get-flags">prelude_msgbuf_get_flags</link>
(<link linkend="prelude-msgbuf-t">prelude_msgbuf_t</link> *msgbuf);
</synopsis>
</refsynopsisdiv>
<refsect1 id="desc">
<title id="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="details">
<title id="details.title">Details</title>
<refsect2>
<title><anchor id="prelude-msgbuf-t" role="typedef"/>prelude_msgbuf_t</title>
<indexterm><primary>prelude_msgbuf_t</primary></indexterm><programlisting>typedef struct prelude_msgbuf prelude_msgbuf_t;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="prelude-msgbuf-flags-t" role="enum"/>enum prelude_msgbuf_flags_t</title>
<indexterm><primary>prelude_msgbuf_flags_t</primary></indexterm><programlisting>typedef enum {
PRELUDE_MSGBUF_FLAGS_ASYNC = 0x01
} prelude_msgbuf_flags_t;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="prelude-msgbuf-new" role="function"/>prelude_msgbuf_new ()</title>
<indexterm><primary>prelude_msgbuf_new</primary></indexterm><programlisting><link linkend="int">int</link> prelude_msgbuf_new (<link linkend="prelude-msgbuf-t">prelude_msgbuf_t</link> **msgbuf);</programlisting>
<para>
Create a new <link linkend="prelude-msgbuf-t"><type>prelude_msgbuf_t</type></link> object and store it into <parameter>msgbuf</parameter>.
You can then write data to <parameter>msgbuf</parameter> using the <link linkend="prelude-msgbuf-set"><function>prelude_msgbuf_set()</function></link> function.
</para>
<para>
When the message buffer is full, the message will be flushed using the
user provided callback.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>msgbuf</parameter> :</term>
<listitem><simpara> Pointer where to store the created <link linkend="prelude-msgbuf-t"><type>prelude_msgbuf_t</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> 0 on success, or a negative value if an error occured.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-msgbuf-destroy" role="function"/>prelude_msgbuf_destroy ()</title>
<indexterm><primary>prelude_msgbuf_destroy</primary></indexterm><programlisting><link linkend="void">void</link> prelude_msgbuf_destroy (<link linkend="prelude-msgbuf-t">prelude_msgbuf_t</link> *msgbuf);</programlisting>
<para>
Destroy <parameter>msgbuf</parameter>, all data remaining will be flushed.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>msgbuf</parameter> :</term>
<listitem><simpara> Pointer on a <link linkend="prelude-msgbuf-t"><type>prelude_msgbuf_t</type></link> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-msgbuf-mark-end" role="function"/>prelude_msgbuf_mark_end ()</title>
<indexterm><primary>prelude_msgbuf_mark_end</primary></indexterm><programlisting><link linkend="void">void</link> prelude_msgbuf_mark_end (<link linkend="prelude-msgbuf-t">prelude_msgbuf_t</link> *msgbuf);</programlisting>
<para>
This function should be called to tell the msgbuf subsystem
that you finished writing your message.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>msgbuf</parameter> :</term>
<listitem><simpara> Pointer on <link linkend="prelude-msgbuf-t"><type>prelude_msgbuf_t</type></link> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-msgbuf-set" role="function"/>prelude_msgbuf_set ()</title>
<indexterm><primary>prelude_msgbuf_set</primary></indexterm><programlisting><link linkend="int">int</link> prelude_msgbuf_set (<link linkend="prelude-msgbuf-t">prelude_msgbuf_t</link> *msgbuf,
<link linkend="uint8-t">uint8_t</link> tag,
<link linkend="uint32-t">uint32_t</link> len,
const <link linkend="void">void</link> *data);</programlisting>
<para>
<link linkend="prelude-msgbuf-set"><function>prelude_msgbuf_set()</function></link> append <parameter>len</parameter> bytes of data from the <parameter>data</parameter> buffer
to the <parameter>msgbuf</parameter> object representing a message. The data is tagged with <parameter>tag</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>msgbuf</parameter> :</term>
<listitem><simpara> Pointer on a <link linkend="prelude-msgbuf-t"><type>prelude_msgbuf_t</type></link> object to store the data to.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>tag</parameter> :</term>
<listitem><simpara> 8 bits unsigned integer describing the kind of data.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>len</parameter> :</term>
<listitem><simpara> len of the data chunk.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara> Pointer to the data.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> 0 on success, a negative value if an error occured.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-msgbuf-get-msg" role="function"/>prelude_msgbuf_get_msg ()</title>
<indexterm><primary>prelude_msgbuf_get_msg</primary></indexterm><programlisting><link linkend="prelude-msg-t">prelude_msg_t</link>* prelude_msgbuf_get_msg (<link linkend="prelude-msgbuf-t">prelude_msgbuf_t</link> *msgbuf);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>msgbuf</parameter> :</term>
<listitem><simpara> Pointer on a <link linkend="prelude-msgbuf-t"><type>prelude_msgbuf_t</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> This function return the current message associated with
the message buffer.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-msgbuf-set-callback" role="function"/>prelude_msgbuf_set_callback ()</title>
<indexterm><primary>prelude_msgbuf_set_callback</primary></indexterm><programlisting><link linkend="void">void</link> prelude_msgbuf_set_callback (<link linkend="prelude-msgbuf-t">prelude_msgbuf_t</link> *msgbuf,
<link linkend="int">int</link> (*send_msg) (prelude_msgbuf_t *msgbuf, prelude_msg_t *msg));</programlisting>
<para>
Associate an application specific callback to this <parameter>msgbuf</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>msgbuf</parameter> :</term>
<listitem><simpara> Pointer on a <link linkend="prelude-msgbuf-t"><type>prelude_msgbuf_t</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>send_msg</parameter> :</term>
<listitem><simpara> Pointer to a function for sending a message.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-msgbuf-set-data" role="function"/>prelude_msgbuf_set_data ()</title>
<indexterm><primary>prelude_msgbuf_set_data</primary></indexterm><programlisting><link linkend="void">void</link> prelude_msgbuf_set_data (<link linkend="prelude-msgbuf-t">prelude_msgbuf_t</link> *msgbuf,
<link linkend="void">void</link> *data);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>msgbuf</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-msgbuf-get-data" role="function"/>prelude_msgbuf_get_data ()</title>
<indexterm><primary>prelude_msgbuf_get_data</primary></indexterm><programlisting><link linkend="void">void</link>* prelude_msgbuf_get_data (<link linkend="prelude-msgbuf-t">prelude_msgbuf_t</link> *msgbuf);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>msgbuf</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-msgbuf-set-flags" role="function"/>prelude_msgbuf_set_flags ()</title>
<indexterm><primary>prelude_msgbuf_set_flags</primary></indexterm><programlisting><link linkend="void">void</link> prelude_msgbuf_set_flags (<link linkend="prelude-msgbuf-t">prelude_msgbuf_t</link> *msgbuf,
<link linkend="prelude-msgbuf-flags-t">prelude_msgbuf_flags_t</link> flags);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>msgbuf</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>flags</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-msgbuf-get-flags" role="function"/>prelude_msgbuf_get_flags ()</title>
<indexterm><primary>prelude_msgbuf_get_flags</primary></indexterm><programlisting><link linkend="prelude-msgbuf-flags-t">prelude_msgbuf_flags_t</link> prelude_msgbuf_get_flags
(<link linkend="prelude-msgbuf-t">prelude_msgbuf_t</link> *msgbuf);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>msgbuf</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
