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
|
<?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="loudmouth-lm-message-node">
<refmeta>
<refentrytitle>LmMessageNode</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LOUDMOUTH Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>LmMessageNode</refname><refpurpose>A node in the message tree</refpurpose>
</refnamediv>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
struct <link linkend="LmMessageNode">LmMessageNode</link>;
const <link linkend="gchar">gchar</link>* <link linkend="lm-message-node-get-value">lm_message_node_get_value</link> (<link linkend="LmMessageNode">LmMessageNode</link> *node);
<link linkend="void">void</link> <link linkend="lm-message-node-set-value">lm_message_node_set_value</link> (<link linkend="LmMessageNode">LmMessageNode</link> *node,
const <link linkend="gchar">gchar</link> *value);
<link linkend="LmMessageNode">LmMessageNode</link>* <link linkend="lm-message-node-add-child">lm_message_node_add_child</link> (<link linkend="LmMessageNode">LmMessageNode</link> *node,
const <link linkend="gchar">gchar</link> *name,
const <link linkend="gchar">gchar</link> *value);
<link linkend="void">void</link> <link linkend="lm-message-node-set-attributes">lm_message_node_set_attributes</link> (<link linkend="LmMessageNode">LmMessageNode</link> *node,
const <link linkend="gchar">gchar</link> *name,
...);
const <link linkend="gchar">gchar</link>* <link linkend="lm-message-node-get-attribute">lm_message_node_get_attribute</link> (<link linkend="LmMessageNode">LmMessageNode</link> *node,
const <link linkend="gchar">gchar</link> *name);
<link linkend="void">void</link> <link linkend="lm-message-node-set-attribute">lm_message_node_set_attribute</link> (<link linkend="LmMessageNode">LmMessageNode</link> *node,
const <link linkend="gchar">gchar</link> *name,
const <link linkend="gchar">gchar</link> *value);
<link linkend="LmMessageNode">LmMessageNode</link>* <link linkend="lm-message-node-get-child">lm_message_node_get_child</link> (<link linkend="LmMessageNode">LmMessageNode</link> *node,
const <link linkend="gchar">gchar</link> *child_name);
<link linkend="LmMessageNode">LmMessageNode</link>* <link linkend="lm-message-node-find-child">lm_message_node_find_child</link> (<link linkend="LmMessageNode">LmMessageNode</link> *node,
const <link linkend="gchar">gchar</link> *child_name);
<link linkend="gboolean">gboolean</link> <link linkend="lm-message-node-get-raw-mode">lm_message_node_get_raw_mode</link> (<link linkend="LmMessageNode">LmMessageNode</link> *node);
<link linkend="void">void</link> <link linkend="lm-message-node-set-raw-mode">lm_message_node_set_raw_mode</link> (<link linkend="LmMessageNode">LmMessageNode</link> *node,
<link linkend="gboolean">gboolean</link> raw_mode);
<link linkend="LmMessageNode">LmMessageNode</link>* <link linkend="lm-message-node-ref">lm_message_node_ref</link> (<link linkend="LmMessageNode">LmMessageNode</link> *node);
<link linkend="void">void</link> <link linkend="lm-message-node-unref">lm_message_node_unref</link> (<link linkend="LmMessageNode">LmMessageNode</link> *node);
<link linkend="gchar">gchar</link>* <link linkend="lm-message-node-to-string">lm_message_node_to_string</link> (<link linkend="LmMessageNode">LmMessageNode</link> *node);
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
</para>
</refsect1>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="LmMessageNode"/>struct LmMessageNode</title>
<indexterm><primary>LmMessageNode</primary></indexterm><programlisting>struct LmMessageNode {
gchar *name;
gchar *value;
gboolean raw_mode;
LmMessageNode *next;
LmMessageNode *prev;
LmMessageNode *parent;
LmMessageNode *children;
};
</programlisting>
<para>
A struct representing a node in a message.
</para><variablelist role="struct">
<varlistentry>
<term><link linkend="gchar">gchar</link> *<structfield>name</structfield></term>
<listitem><simpara>the name of the node
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gchar">gchar</link> *<structfield>value</structfield></term>
<listitem><simpara>value of the node, can be NULL
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gboolean">gboolean</link> <structfield>raw_mode</structfield></term>
<listitem><simpara>if true, don't escape the content of the message. The content must be valid XML.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="LmMessageNode">LmMessageNode</link> *<structfield>next</structfield></term>
<listitem><simpara>next sibling
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="LmMessageNode">LmMessageNode</link> *<structfield>prev</structfield></term>
<listitem><simpara>previous sibling
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="LmMessageNode">LmMessageNode</link> *<structfield>parent</structfield></term>
<listitem><simpara>node parent
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="LmMessageNode">LmMessageNode</link> *<structfield>children</structfield></term>
<listitem><simpara>pointing to first child
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="lm-message-node-get-value"/>lm_message_node_get_value ()</title>
<indexterm><primary>lm_message_node_get_value</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* lm_message_node_get_value (<link linkend="LmMessageNode">LmMessageNode</link> *node);</programlisting>
<para>
Retrieves the value of <parameter>node</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter> :</term>
<listitem><simpara> an <link linkend="LmMessageNode"><type>LmMessageNode</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="lm-message-node-set-value"/>lm_message_node_set_value ()</title>
<indexterm><primary>lm_message_node_set_value</primary></indexterm><programlisting><link linkend="void">void</link> lm_message_node_set_value (<link linkend="LmMessageNode">LmMessageNode</link> *node,
const <link linkend="gchar">gchar</link> *value);</programlisting>
<para>
Sets the value of <parameter>node</parameter>. If a previous value is set it will be freed.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter> :</term>
<listitem><simpara> an <link linkend="LmMessageNode"><type>LmMessageNode</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> the new value.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="lm-message-node-add-child"/>lm_message_node_add_child ()</title>
<indexterm><primary>lm_message_node_add_child</primary></indexterm><programlisting><link linkend="LmMessageNode">LmMessageNode</link>* lm_message_node_add_child (<link linkend="LmMessageNode">LmMessageNode</link> *node,
const <link linkend="gchar">gchar</link> *name,
const <link linkend="gchar">gchar</link> *value);</programlisting>
<para>
Add a child node with <parameter>name</parameter> and value set to <parameter>value</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter> :</term>
<listitem><simpara> an <link linkend="LmMessageNode"><type>LmMessageNode</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> the name of the new child
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> value of the new child
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the newly created child
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="lm-message-node-set-attributes"/>lm_message_node_set_attributes ()</title>
<indexterm><primary>lm_message_node_set_attributes</primary></indexterm><programlisting><link linkend="void">void</link> lm_message_node_set_attributes (<link linkend="LmMessageNode">LmMessageNode</link> *node,
const <link linkend="gchar">gchar</link> *name,
...);</programlisting>
<para>
Sets a list of attributes. The arguments should be names and corresponding
value and needs to be ended with <literal>NULL</literal>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter> :</term>
<listitem><simpara> an <link linkend="LmMessageNode"><type>LmMessageNode</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> the first attribute, should be followed by a string with the value
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>...</parameter> :</term>
<listitem><simpara> The rest of the name/value pairs
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="lm-message-node-get-attribute"/>lm_message_node_get_attribute ()</title>
<indexterm><primary>lm_message_node_get_attribute</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* lm_message_node_get_attribute (<link linkend="LmMessageNode">LmMessageNode</link> *node,
const <link linkend="gchar">gchar</link> *name);</programlisting>
<para>
Fetches the attribute <parameter>name</parameter> from <parameter>node</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter> :</term>
<listitem><simpara> an <link linkend="LmMessageNode"><type>LmMessageNode</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> the attribute name
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the attribute value or <literal>NULL</literal> if not set
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="lm-message-node-set-attribute"/>lm_message_node_set_attribute ()</title>
<indexterm><primary>lm_message_node_set_attribute</primary></indexterm><programlisting><link linkend="void">void</link> lm_message_node_set_attribute (<link linkend="LmMessageNode">LmMessageNode</link> *node,
const <link linkend="gchar">gchar</link> *name,
const <link linkend="gchar">gchar</link> *value);</programlisting>
<para>
Sets the attribute <parameter>name</parameter> to <parameter>value</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter> :</term>
<listitem><simpara> an <link linkend="LmMessageNode"><type>LmMessageNode</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> name of attribute
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> value of attribute.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="lm-message-node-get-child"/>lm_message_node_get_child ()</title>
<indexterm><primary>lm_message_node_get_child</primary></indexterm><programlisting><link linkend="LmMessageNode">LmMessageNode</link>* lm_message_node_get_child (<link linkend="LmMessageNode">LmMessageNode</link> *node,
const <link linkend="gchar">gchar</link> *child_name);</programlisting>
<para>
Fetches the child <parameter>child_name</parameter> from <parameter>node</parameter>. If child is not found as an
immediate child of <parameter>node</parameter> <literal>NULL</literal> is returned.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter> :</term>
<listitem><simpara> an <link linkend="LmMessageNode"><type>LmMessageNode</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>child_name</parameter> :</term>
<listitem><simpara> the childs name
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the child node or <literal>NULL</literal> if not found
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="lm-message-node-find-child"/>lm_message_node_find_child ()</title>
<indexterm><primary>lm_message_node_find_child</primary></indexterm><programlisting><link linkend="LmMessageNode">LmMessageNode</link>* lm_message_node_find_child (<link linkend="LmMessageNode">LmMessageNode</link> *node,
const <link linkend="gchar">gchar</link> *child_name);</programlisting>
<para>
Locates a child among all children of <parameter>node</parameter>. The entire tree will be search
until a child with name <parameter>child_name</parameter> is located.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter> :</term>
<listitem><simpara> A <link linkend="LmMessageNode"><type>LmMessageNode</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>child_name</parameter> :</term>
<listitem><simpara> The name of the child to find
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the located child or <literal>NULL</literal> if not found
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="lm-message-node-get-raw-mode"/>lm_message_node_get_raw_mode ()</title>
<indexterm><primary>lm_message_node_get_raw_mode</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> lm_message_node_get_raw_mode (<link linkend="LmMessageNode">LmMessageNode</link> *node);</programlisting>
<para>
Checks if the nodes value should be sent as raw mode.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter> :</term>
<listitem><simpara> an <link linkend="LmMessageNode"><type>LmMessageNode</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if nodes value should be sent as is and <literal>FALSE</literal> if the value will be escaped before sending.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="lm-message-node-set-raw-mode"/>lm_message_node_set_raw_mode ()</title>
<indexterm><primary>lm_message_node_set_raw_mode</primary></indexterm><programlisting><link linkend="void">void</link> lm_message_node_set_raw_mode (<link linkend="LmMessageNode">LmMessageNode</link> *node,
<link linkend="gboolean">gboolean</link> raw_mode);</programlisting>
<para>
Set <parameter>raw_mode</parameter> to <literal>TRUE</literal> if you don't want to escape the value. You need to make sure the value is valid XML yourself.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter> :</term>
<listitem><simpara> an <link linkend="LmMessageNode"><type>LmMessageNode</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>raw_mode</parameter> :</term>
<listitem><simpara> boolean specifying if node value should be escaped or not.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="lm-message-node-ref"/>lm_message_node_ref ()</title>
<indexterm><primary>lm_message_node_ref</primary></indexterm><programlisting><link linkend="LmMessageNode">LmMessageNode</link>* lm_message_node_ref (<link linkend="LmMessageNode">LmMessageNode</link> *node);</programlisting>
<para>
Adds a reference to <parameter>node</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter> :</term>
<listitem><simpara> an <link linkend="LmMessageNode"><type>LmMessageNode</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the node
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="lm-message-node-unref"/>lm_message_node_unref ()</title>
<indexterm><primary>lm_message_node_unref</primary></indexterm><programlisting><link linkend="void">void</link> lm_message_node_unref (<link linkend="LmMessageNode">LmMessageNode</link> *node);</programlisting>
<para>
Removes a reference from <parameter>node</parameter>. When no more references are present the
node is freed. When freed <link linkend="lm-message-node-unref"><function>lm_message_node_unref()</function></link> will be called on all
children. If caller needs to keep references to the children a call to
<link linkend="lm-message-node-ref"><function>lm_message_node_ref()</function></link> needs to be done before the call to
<link linkend="lm-message-unref"><function>lm_message_unref()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter> :</term>
<listitem><simpara> an <link linkend="LmMessageNode"><type>LmMessageNode</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="lm-message-node-to-string"/>lm_message_node_to_string ()</title>
<indexterm><primary>lm_message_node_to_string</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* lm_message_node_to_string (<link linkend="LmMessageNode">LmMessageNode</link> *node);</programlisting>
<para>
Returns an XML string representing the node. This is what is sent over the
wire. This is used internally Loudmouth and is external for debugging
purposes.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>node</parameter> :</term>
<listitem><simpara> an <link linkend="LmMessageNode"><type>LmMessageNode</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> an XML string representation of <parameter>node</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
