2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
<refentry id="libedataserver-e-msgport">
6
<refentrytitle role="top_of_page" id="libedataserver-e-msgport.top_of_page">e-msgport</refentrytitle>
7
<manvolnum>3</manvolnum>
13
<refname>e-msgport</refname>
14
<refpurpose></refpurpose>
17
<refsynopsisdiv id="libedataserver-e-msgport.synopsis" role="synopsis">
18
<title role="synopsis.title">Synopsis</title>
20
<synopsis> <link linkend="EDListNode">EDListNode</link>;
21
<link linkend="EDList">EDList</link>;
22
#define <link linkend="E-DLIST-INITIALISER:CAPS">E_DLIST_INITIALISER</link> (l)
23
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-dlist-init">e_dlist_init</link> (<parameter><link linkend="EDList"><type>EDList</type></link> *v</parameter>);
24
<link linkend="EDListNode"><returnvalue>EDListNode</returnvalue></link> * <link linkend="e-dlist-addhead">e_dlist_addhead</link> (<parameter><link linkend="EDList"><type>EDList</type></link> *l</parameter>,
25
<parameter><link linkend="EDListNode"><type>EDListNode</type></link> *n</parameter>);
26
<link linkend="EDListNode"><returnvalue>EDListNode</returnvalue></link> * <link linkend="e-dlist-addtail">e_dlist_addtail</link> (<parameter><link linkend="EDList"><type>EDList</type></link> *l</parameter>,
27
<parameter><link linkend="EDListNode"><type>EDListNode</type></link> *n</parameter>);
28
<link linkend="EDListNode"><returnvalue>EDListNode</returnvalue></link> * <link linkend="e-dlist-remove">e_dlist_remove</link> (<parameter><link linkend="EDListNode"><type>EDListNode</type></link> *n</parameter>);
29
<link linkend="EDListNode"><returnvalue>EDListNode</returnvalue></link> * <link linkend="e-dlist-remhead">e_dlist_remhead</link> (<parameter><link linkend="EDList"><type>EDList</type></link> *l</parameter>);
30
<link linkend="EDListNode"><returnvalue>EDListNode</returnvalue></link> * <link linkend="e-dlist-remtail">e_dlist_remtail</link> (<parameter><link linkend="EDList"><type>EDList</type></link> *l</parameter>);
31
<link linkend="gint"><returnvalue>gint</returnvalue></link> <link linkend="e-dlist-empty">e_dlist_empty</link> (<parameter><link linkend="EDList"><type>EDList</type></link> *l</parameter>);
32
<link linkend="gint"><returnvalue>gint</returnvalue></link> <link linkend="e-dlist-length">e_dlist_length</link> (<parameter><link linkend="EDList"><type>EDList</type></link> *l</parameter>);
33
<link linkend="EMCache">EMCache</link>;
34
<link linkend="EMCacheNode">EMCacheNode</link>;
35
<link linkend="EMCache"><returnvalue>EMCache</returnvalue></link> * <link linkend="em-cache-new">em_cache_new</link> (<parameter><link linkend="time-t"><type>time_t</type></link> timeout</parameter>,
36
<parameter><link linkend="gsize"><type>gsize</type></link> nodesize</parameter>,
37
<parameter><link linkend="GFreeFunc"><type>GFreeFunc</type></link> nodefree</parameter>);
38
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="em-cache-destroy">em_cache_destroy</link> (<parameter><link linkend="EMCache"><type>EMCache</type></link> *emc</parameter>);
39
<link linkend="EMCacheNode"><returnvalue>EMCacheNode</returnvalue></link> * <link linkend="em-cache-lookup">em_cache_lookup</link> (<parameter><link linkend="EMCache"><type>EMCache</type></link> *emc</parameter>,
40
<parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>);
41
<link linkend="EMCacheNode"><returnvalue>EMCacheNode</returnvalue></link> * <link linkend="em-cache-node-new">em_cache_node_new</link> (<parameter><link linkend="EMCache"><type>EMCache</type></link> *emc</parameter>,
42
<parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>);
43
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="em-cache-node-unref">em_cache_node_unref</link> (<parameter><link linkend="EMCache"><type>EMCache</type></link> *emc</parameter>,
44
<parameter><link linkend="EMCacheNode"><type>EMCacheNode</type></link> *n</parameter>);
45
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="em-cache-add">em_cache_add</link> (<parameter><link linkend="EMCache"><type>EMCache</type></link> *emc</parameter>,
46
<parameter><link linkend="EMCacheNode"><type>EMCacheNode</type></link> *n</parameter>);
47
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="em-cache-clear">em_cache_clear</link> (<parameter><link linkend="EMCache"><type>EMCache</type></link> *emc</parameter>);
48
<link linkend="EMsgPort">EMsgPort</link>;
49
<link linkend="EMsg">EMsg</link>;
50
<link linkend="EMsgPort"><returnvalue>EMsgPort</returnvalue></link> * <link linkend="e-msgport-new">e_msgport_new</link> (<parameter><type>void</type></parameter>);
51
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-msgport-destroy">e_msgport_destroy</link> (<parameter><link linkend="EMsgPort"><type>EMsgPort</type></link> *mp</parameter>);
52
<link linkend="gint"><returnvalue>gint</returnvalue></link> <link linkend="e-msgport-fd">e_msgport_fd</link> (<parameter><link linkend="EMsgPort"><type>EMsgPort</type></link> *mp</parameter>);
53
struct <link linkend="PRFileDesc"><returnvalue>PRFileDesc</returnvalue></link> * <link linkend="e-msgport-prfd">e_msgport_prfd</link> (<parameter><link linkend="EMsgPort"><type>EMsgPort</type></link> *mp</parameter>);
54
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-msgport-put">e_msgport_put</link> (<parameter><link linkend="EMsgPort"><type>EMsgPort</type></link> *mp</parameter>,
55
<parameter><link linkend="EMsg"><type>EMsg</type></link> *msg</parameter>);
56
<link linkend="EMsg"><returnvalue>EMsg</returnvalue></link> * <link linkend="e-msgport-wait">e_msgport_wait</link> (<parameter><link linkend="EMsgPort"><type>EMsgPort</type></link> *mp</parameter>);
57
<link linkend="EMsg"><returnvalue>EMsg</returnvalue></link> * <link linkend="e-msgport-get">e_msgport_get</link> (<parameter><link linkend="EMsgPort"><type>EMsgPort</type></link> *mp</parameter>);
58
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-msgport-reply">e_msgport_reply</link> (<parameter><link linkend="EMsg"><type>EMsg</type></link> *msg</parameter>);
59
<link linkend="EThread">EThread</link>;
60
enum <link linkend="e-thread-t">e_thread_t</link>;
61
<link linkend="void"><returnvalue>void</returnvalue></link> (<link linkend="EThreadFunc">*EThreadFunc</link>) (<parameter><link linkend="EThread"><type>EThread</type></link> *Param1</parameter>,
62
<parameter><link linkend="EMsg"><type>EMsg</type></link> *Param2</parameter>,
63
<parameter><link linkend="gpointer"><type>gpointer</type></link> data</parameter>);
64
<link linkend="EThread"><returnvalue>EThread</returnvalue></link> * <link linkend="e-thread-new">e_thread_new</link> (<parameter><link linkend="e-thread-t"><type>e_thread_t</type></link> type</parameter>);
65
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-thread-destroy">e_thread_destroy</link> (<parameter><link linkend="EThread"><type>EThread</type></link> *e</parameter>);
66
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-thread-set-queue-limit">e_thread_set_queue_limit</link> (<parameter><link linkend="EThread"><type>EThread</type></link> *e</parameter>,
67
<parameter><link linkend="gint"><type>gint</type></link> limit</parameter>);
68
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-thread-set-msg-lost">e_thread_set_msg_lost</link> (<parameter><link linkend="EThread"><type>EThread</type></link> *e</parameter>,
69
<parameter><link linkend="EThreadFunc"><type>EThreadFunc</type></link> destroy</parameter>,
70
<parameter><link linkend="gpointer"><type>gpointer</type></link> data</parameter>);
71
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-thread-set-msg-destroy">e_thread_set_msg_destroy</link> (<parameter><link linkend="EThread"><type>EThread</type></link> *e</parameter>,
72
<parameter><link linkend="EThreadFunc"><type>EThreadFunc</type></link> destroy</parameter>,
73
<parameter><link linkend="gpointer"><type>gpointer</type></link> data</parameter>);
74
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-thread-set-reply-port">e_thread_set_reply_port</link> (<parameter><link linkend="EThread"><type>EThread</type></link> *e</parameter>,
75
<parameter><link linkend="EMsgPort"><type>EMsgPort</type></link> *reply_port</parameter>);
76
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-thread-set-msg-received">e_thread_set_msg_received</link> (<parameter><link linkend="EThread"><type>EThread</type></link> *e</parameter>,
77
<parameter><link linkend="EThreadFunc"><type>EThreadFunc</type></link> received</parameter>,
78
<parameter><link linkend="gpointer"><type>gpointer</type></link> data</parameter>);
79
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-thread-put">e_thread_put</link> (<parameter><link linkend="EThread"><type>EThread</type></link> *e</parameter>,
80
<parameter><link linkend="EMsg"><type>EMsg</type></link> *msg</parameter>);
81
<link linkend="gint"><returnvalue>gint</returnvalue></link> <link linkend="e-thread-busy">e_thread_busy</link> (<parameter><link linkend="EThread"><type>EThread</type></link> *e</parameter>);
82
<link linkend="EMutex">EMutex</link>;
83
enum <link linkend="e-mutex-t">e_mutex_t</link>;
84
<link linkend="EMutex"><returnvalue>EMutex</returnvalue></link> * <link linkend="e-mutex-new">e_mutex_new</link> (<parameter><link linkend="e-mutex-t"><type>e_mutex_t</type></link> type</parameter>);
85
<link linkend="gint"><returnvalue>gint</returnvalue></link> <link linkend="e-mutex-destroy">e_mutex_destroy</link> (<parameter><link linkend="EMutex"><type>EMutex</type></link> *m</parameter>);
86
<link linkend="gint"><returnvalue>gint</returnvalue></link> <link linkend="e-mutex-lock">e_mutex_lock</link> (<parameter><link linkend="EMutex"><type>EMutex</type></link> *m</parameter>);
87
<link linkend="gint"><returnvalue>gint</returnvalue></link> <link linkend="e-mutex-unlock">e_mutex_unlock</link> (<parameter><link linkend="EMutex"><type>EMutex</type></link> *m</parameter>);
88
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-mutex-assert-locked">e_mutex_assert_locked</link> (<parameter><link linkend="EMutex"><type>EMutex</type></link> *m</parameter>);
89
<link linkend="gint"><returnvalue>gint</returnvalue></link> <link linkend="e-mutex-cond-wait">e_mutex_cond_wait</link> (<parameter><link linkend="gpointer"><type>gpointer</type></link> cond</parameter>,
90
<parameter><link linkend="EMutex"><type>EMutex</type></link> *m</parameter>);
94
<refsect1 id="libedataserver-e-msgport.description" role="desc">
95
<title role="desc.title">Description</title>
99
<refsect1 id="libedataserver-e-msgport.details" role="details">
100
<title role="details.title">Details</title>
101
<refsect2 id="EDListNode" role="struct">
102
<title>EDListNode</title>
103
<indexterm zone="EDListNode"><primary>EDListNode</primary></indexterm>
104
<programlisting>typedef struct {
105
struct _EDListNode *next;
106
struct _EDListNode *prev;
111
<refsect2 id="EDList" role="struct">
112
<title>EDList</title>
113
<indexterm zone="EDList"><primary>EDList</primary></indexterm>
114
<programlisting>typedef struct {
115
struct _EDListNode *head;
116
struct _EDListNode *tail;
117
struct _EDListNode *tailpred;
122
<refsect2 id="E-DLIST-INITIALISER:CAPS" role="macro">
123
<title>E_DLIST_INITIALISER()</title>
124
<indexterm zone="E-DLIST-INITIALISER:CAPS"><primary>E_DLIST_INITIALISER</primary></indexterm>
125
<programlisting>#define E_DLIST_INITIALISER(l) { (EDListNode *)&l.tail, NULL, (EDListNode *)&l.head }
128
</para><variablelist role="params">
129
<varlistentry><term><parameter>l</parameter> :</term>
131
</simpara></listitem></varlistentry>
132
</variablelist></refsect2>
133
<refsect2 id="e-dlist-init" role="function">
134
<title>e_dlist_init ()</title>
135
<indexterm zone="e-dlist-init"><primary>e_dlist_init</primary></indexterm>
136
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_dlist_init (<parameter><link linkend="EDList"><type>EDList</type></link> *v</parameter>);</programlisting>
138
</para><variablelist role="params">
139
<varlistentry><term><parameter>v</parameter> :</term>
141
</simpara></listitem></varlistentry>
142
</variablelist></refsect2>
143
<refsect2 id="e-dlist-addhead" role="function">
144
<title>e_dlist_addhead ()</title>
145
<indexterm zone="e-dlist-addhead"><primary>e_dlist_addhead</primary></indexterm>
146
<programlisting><link linkend="EDListNode"><returnvalue>EDListNode</returnvalue></link> * e_dlist_addhead (<parameter><link linkend="EDList"><type>EDList</type></link> *l</parameter>,
147
<parameter><link linkend="EDListNode"><type>EDListNode</type></link> *n</parameter>);</programlisting>
149
</para><variablelist role="params">
150
<varlistentry><term><parameter>l</parameter> :</term>
152
</simpara></listitem></varlistentry>
153
<varlistentry><term><parameter>n</parameter> :</term>
155
</simpara></listitem></varlistentry>
156
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
157
</simpara></listitem></varlistentry>
158
</variablelist></refsect2>
159
<refsect2 id="e-dlist-addtail" role="function">
160
<title>e_dlist_addtail ()</title>
161
<indexterm zone="e-dlist-addtail"><primary>e_dlist_addtail</primary></indexterm>
162
<programlisting><link linkend="EDListNode"><returnvalue>EDListNode</returnvalue></link> * e_dlist_addtail (<parameter><link linkend="EDList"><type>EDList</type></link> *l</parameter>,
163
<parameter><link linkend="EDListNode"><type>EDListNode</type></link> *n</parameter>);</programlisting>
165
</para><variablelist role="params">
166
<varlistentry><term><parameter>l</parameter> :</term>
168
</simpara></listitem></varlistentry>
169
<varlistentry><term><parameter>n</parameter> :</term>
171
</simpara></listitem></varlistentry>
172
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
173
</simpara></listitem></varlistentry>
174
</variablelist></refsect2>
175
<refsect2 id="e-dlist-remove" role="function">
176
<title>e_dlist_remove ()</title>
177
<indexterm zone="e-dlist-remove"><primary>e_dlist_remove</primary></indexterm>
178
<programlisting><link linkend="EDListNode"><returnvalue>EDListNode</returnvalue></link> * e_dlist_remove (<parameter><link linkend="EDListNode"><type>EDListNode</type></link> *n</parameter>);</programlisting>
180
</para><variablelist role="params">
181
<varlistentry><term><parameter>n</parameter> :</term>
183
</simpara></listitem></varlistentry>
184
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
185
</simpara></listitem></varlistentry>
186
</variablelist></refsect2>
187
<refsect2 id="e-dlist-remhead" role="function">
188
<title>e_dlist_remhead ()</title>
189
<indexterm zone="e-dlist-remhead"><primary>e_dlist_remhead</primary></indexterm>
190
<programlisting><link linkend="EDListNode"><returnvalue>EDListNode</returnvalue></link> * e_dlist_remhead (<parameter><link linkend="EDList"><type>EDList</type></link> *l</parameter>);</programlisting>
192
</para><variablelist role="params">
193
<varlistentry><term><parameter>l</parameter> :</term>
195
</simpara></listitem></varlistentry>
196
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
197
</simpara></listitem></varlistentry>
198
</variablelist></refsect2>
199
<refsect2 id="e-dlist-remtail" role="function">
200
<title>e_dlist_remtail ()</title>
201
<indexterm zone="e-dlist-remtail"><primary>e_dlist_remtail</primary></indexterm>
202
<programlisting><link linkend="EDListNode"><returnvalue>EDListNode</returnvalue></link> * e_dlist_remtail (<parameter><link linkend="EDList"><type>EDList</type></link> *l</parameter>);</programlisting>
204
</para><variablelist role="params">
205
<varlistentry><term><parameter>l</parameter> :</term>
207
</simpara></listitem></varlistentry>
208
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
209
</simpara></listitem></varlistentry>
210
</variablelist></refsect2>
211
<refsect2 id="e-dlist-empty" role="function">
212
<title>e_dlist_empty ()</title>
213
<indexterm zone="e-dlist-empty"><primary>e_dlist_empty</primary></indexterm>
214
<programlisting><link linkend="gint"><returnvalue>gint</returnvalue></link> e_dlist_empty (<parameter><link linkend="EDList"><type>EDList</type></link> *l</parameter>);</programlisting>
216
</para><variablelist role="params">
217
<varlistentry><term><parameter>l</parameter> :</term>
219
</simpara></listitem></varlistentry>
220
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
221
</simpara></listitem></varlistentry>
222
</variablelist></refsect2>
223
<refsect2 id="e-dlist-length" role="function">
224
<title>e_dlist_length ()</title>
225
<indexterm zone="e-dlist-length"><primary>e_dlist_length</primary></indexterm>
226
<programlisting><link linkend="gint"><returnvalue>gint</returnvalue></link> e_dlist_length (<parameter><link linkend="EDList"><type>EDList</type></link> *l</parameter>);</programlisting>
228
</para><variablelist role="params">
229
<varlistentry><term><parameter>l</parameter> :</term>
231
</simpara></listitem></varlistentry>
232
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
233
</simpara></listitem></varlistentry>
234
</variablelist></refsect2>
235
<refsect2 id="EMCache" role="struct">
236
<title>EMCache</title>
237
<indexterm zone="EMCache"><primary>EMCache</primary></indexterm>
238
<programlisting>typedef struct _EMCache EMCache;</programlisting>
241
<refsect2 id="EMCacheNode" role="struct">
242
<title>EMCacheNode</title>
243
<indexterm zone="EMCacheNode"><primary>EMCacheNode</primary></indexterm>
244
<programlisting>typedef struct {
245
struct _EMCacheNode *next, *prev;
253
<refsect2 id="em-cache-new" role="function">
254
<title>em_cache_new ()</title>
255
<indexterm zone="em-cache-new"><primary>em_cache_new</primary></indexterm>
256
<programlisting><link linkend="EMCache"><returnvalue>EMCache</returnvalue></link> * em_cache_new (<parameter><link linkend="time-t"><type>time_t</type></link> timeout</parameter>,
257
<parameter><link linkend="gsize"><type>gsize</type></link> nodesize</parameter>,
258
<parameter><link linkend="GFreeFunc"><type>GFreeFunc</type></link> nodefree</parameter>);</programlisting>
260
Setup a new timeout cache. <parameter>nodesize</parameter> is the size of nodes in the
261
cache, and <parameter>nodefree</parameter> will be called to free YOUR content.</para>
262
<variablelist role="params">
263
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
264
</simpara></listitem></varlistentry>
265
</variablelist></refsect2>
266
<refsect2 id="em-cache-destroy" role="function">
267
<title>em_cache_destroy ()</title>
268
<indexterm zone="em-cache-destroy"><primary>em_cache_destroy</primary></indexterm>
269
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> em_cache_destroy (<parameter><link linkend="EMCache"><type>EMCache</type></link> *emc</parameter>);</programlisting>
271
destroy the cache, duh.</para>
273
<refsect2 id="em-cache-lookup" role="function">
274
<title>em_cache_lookup ()</title>
275
<indexterm zone="em-cache-lookup"><primary>em_cache_lookup</primary></indexterm>
276
<programlisting><link linkend="EMCacheNode"><returnvalue>EMCacheNode</returnvalue></link> * em_cache_lookup (<parameter><link linkend="EMCache"><type>EMCache</type></link> *emc</parameter>,
277
<parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>);</programlisting>
279
Lookup a cache node. once you're finished with it, you need to
281
<variablelist role="params">
282
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
283
</simpara></listitem></varlistentry>
284
</variablelist></refsect2>
285
<refsect2 id="em-cache-node-new" role="function">
286
<title>em_cache_node_new ()</title>
287
<indexterm zone="em-cache-node-new"><primary>em_cache_node_new</primary></indexterm>
288
<programlisting><link linkend="EMCacheNode"><returnvalue>EMCacheNode</returnvalue></link> * em_cache_node_new (<parameter><link linkend="EMCache"><type>EMCache</type></link> *emc</parameter>,
289
<parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>);</programlisting>
291
Create a new key'd cache node. The node will not be added to the
292
cache until you insert it.</para>
293
<variablelist role="params">
294
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
295
</simpara></listitem></varlistentry>
296
</variablelist></refsect2>
297
<refsect2 id="em-cache-node-unref" role="function">
298
<title>em_cache_node_unref ()</title>
299
<indexterm zone="em-cache-node-unref"><primary>em_cache_node_unref</primary></indexterm>
300
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> em_cache_node_unref (<parameter><link linkend="EMCache"><type>EMCache</type></link> *emc</parameter>,
301
<parameter><link linkend="EMCacheNode"><type>EMCacheNode</type></link> *n</parameter>);</programlisting>
303
unref a cache node, you can only unref nodes which have been looked
306
<refsect2 id="em-cache-add" role="function">
307
<title>em_cache_add ()</title>
308
<indexterm zone="em-cache-add"><primary>em_cache_add</primary></indexterm>
309
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> em_cache_add (<parameter><link linkend="EMCache"><type>EMCache</type></link> *emc</parameter>,
310
<parameter><link linkend="EMCacheNode"><type>EMCacheNode</type></link> *n</parameter>);</programlisting>
312
Add a cache node to the cache, once added the memory is owned by
313
the cache. If there are conflicts and the old node is still in
314
use, then the new node is not added, otherwise it is added and any
315
nodes older than the expire time are flushed.</para>
317
<refsect2 id="em-cache-clear" role="function">
318
<title>em_cache_clear ()</title>
319
<indexterm zone="em-cache-clear"><primary>em_cache_clear</primary></indexterm>
320
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> em_cache_clear (<parameter><link linkend="EMCache"><type>EMCache</type></link> *emc</parameter>);</programlisting>
322
clear the cache. just for api completeness.</para>
324
<refsect2 id="EMsgPort" role="struct" condition="deprecated:">
325
<title>EMsgPort</title>
326
<indexterm zone="EMsgPort" role="deprecated"><primary>EMsgPort</primary></indexterm>
327
<programlisting>typedef struct _EMsgPort EMsgPort;</programlisting>
328
<warning><para><literal>EMsgPort</literal> is deprecated and should not be used in newly-written code.</para></warning>
331
<refsect2 id="EMsg" role="struct" condition="deprecated:">
333
<indexterm zone="EMsg" role="deprecated"><primary>EMsg</primary></indexterm>
334
<programlisting>typedef struct {
336
EMsgPort *reply_port;
340
<warning><para><literal>EMsg</literal> is deprecated and should not be used in newly-written code.</para></warning>
343
<refsect2 id="e-msgport-new" role="function" condition="deprecated:">
344
<title>e_msgport_new ()</title>
345
<indexterm zone="e-msgport-new" role="deprecated"><primary>e_msgport_new</primary></indexterm>
346
<programlisting><link linkend="EMsgPort"><returnvalue>EMsgPort</returnvalue></link> * e_msgport_new (<parameter><type>void</type></parameter>);</programlisting>
347
<warning><para><literal>e_msgport_new</literal> is deprecated and should not be used in newly-written code.</para></warning>
349
</para><variablelist role="params">
350
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
351
</simpara></listitem></varlistentry>
352
</variablelist></refsect2>
353
<refsect2 id="e-msgport-destroy" role="function" condition="deprecated:">
354
<title>e_msgport_destroy ()</title>
355
<indexterm zone="e-msgport-destroy" role="deprecated"><primary>e_msgport_destroy</primary></indexterm>
356
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_msgport_destroy (<parameter><link linkend="EMsgPort"><type>EMsgPort</type></link> *mp</parameter>);</programlisting>
357
<warning><para><literal>e_msgport_destroy</literal> is deprecated and should not be used in newly-written code.</para></warning>
359
</para><variablelist role="params">
360
<varlistentry><term><parameter>mp</parameter> :</term>
362
</simpara></listitem></varlistentry>
363
</variablelist></refsect2>
364
<refsect2 id="e-msgport-fd" role="function" condition="deprecated:">
365
<title>e_msgport_fd ()</title>
366
<indexterm zone="e-msgport-fd" role="deprecated"><primary>e_msgport_fd</primary></indexterm>
367
<programlisting><link linkend="gint"><returnvalue>gint</returnvalue></link> e_msgport_fd (<parameter><link linkend="EMsgPort"><type>EMsgPort</type></link> *mp</parameter>);</programlisting>
368
<warning><para><literal>e_msgport_fd</literal> is deprecated and should not be used in newly-written code.</para></warning>
370
</para><variablelist role="params">
371
<varlistentry><term><parameter>mp</parameter> :</term>
373
</simpara></listitem></varlistentry>
374
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
375
</simpara></listitem></varlistentry>
376
</variablelist></refsect2>
377
<refsect2 id="e-msgport-prfd" role="function" condition="deprecated:">
378
<title>e_msgport_prfd ()</title>
379
<indexterm zone="e-msgport-prfd" role="deprecated"><primary>e_msgport_prfd</primary></indexterm>
380
<programlisting>struct <link linkend="PRFileDesc"><returnvalue>PRFileDesc</returnvalue></link> * e_msgport_prfd (<parameter><link linkend="EMsgPort"><type>EMsgPort</type></link> *mp</parameter>);</programlisting>
381
<warning><para><literal>e_msgport_prfd</literal> is deprecated and should not be used in newly-written code.</para></warning>
383
</para><variablelist role="params">
384
<varlistentry><term><parameter>mp</parameter> :</term>
386
</simpara></listitem></varlistentry>
387
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
388
</simpara></listitem></varlistentry>
389
</variablelist></refsect2>
390
<refsect2 id="e-msgport-put" role="function" condition="deprecated:">
391
<title>e_msgport_put ()</title>
392
<indexterm zone="e-msgport-put" role="deprecated"><primary>e_msgport_put</primary></indexterm>
393
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_msgport_put (<parameter><link linkend="EMsgPort"><type>EMsgPort</type></link> *mp</parameter>,
394
<parameter><link linkend="EMsg"><type>EMsg</type></link> *msg</parameter>);</programlisting>
395
<warning><para><literal>e_msgport_put</literal> is deprecated and should not be used in newly-written code.</para></warning>
397
</para><variablelist role="params">
398
<varlistentry><term><parameter>mp</parameter> :</term>
400
</simpara></listitem></varlistentry>
401
<varlistentry><term><parameter>msg</parameter> :</term>
403
</simpara></listitem></varlistentry>
404
</variablelist></refsect2>
405
<refsect2 id="e-msgport-wait" role="function" condition="deprecated:">
406
<title>e_msgport_wait ()</title>
407
<indexterm zone="e-msgport-wait" role="deprecated"><primary>e_msgport_wait</primary></indexterm>
408
<programlisting><link linkend="EMsg"><returnvalue>EMsg</returnvalue></link> * e_msgport_wait (<parameter><link linkend="EMsgPort"><type>EMsgPort</type></link> *mp</parameter>);</programlisting>
409
<warning><para><literal>e_msgport_wait</literal> is deprecated and should not be used in newly-written code.</para></warning>
411
</para><variablelist role="params">
412
<varlistentry><term><parameter>mp</parameter> :</term>
414
</simpara></listitem></varlistentry>
415
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
416
</simpara></listitem></varlistentry>
417
</variablelist></refsect2>
418
<refsect2 id="e-msgport-get" role="function" condition="deprecated:">
419
<title>e_msgport_get ()</title>
420
<indexterm zone="e-msgport-get" role="deprecated"><primary>e_msgport_get</primary></indexterm>
421
<programlisting><link linkend="EMsg"><returnvalue>EMsg</returnvalue></link> * e_msgport_get (<parameter><link linkend="EMsgPort"><type>EMsgPort</type></link> *mp</parameter>);</programlisting>
422
<warning><para><literal>e_msgport_get</literal> is deprecated and should not be used in newly-written code.</para></warning>
424
</para><variablelist role="params">
425
<varlistentry><term><parameter>mp</parameter> :</term>
427
</simpara></listitem></varlistentry>
428
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
429
</simpara></listitem></varlistentry>
430
</variablelist></refsect2>
431
<refsect2 id="e-msgport-reply" role="function" condition="deprecated:">
432
<title>e_msgport_reply ()</title>
433
<indexterm zone="e-msgport-reply" role="deprecated"><primary>e_msgport_reply</primary></indexterm>
434
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_msgport_reply (<parameter><link linkend="EMsg"><type>EMsg</type></link> *msg</parameter>);</programlisting>
435
<warning><para><literal>e_msgport_reply</literal> is deprecated and should not be used in newly-written code.</para></warning>
437
</para><variablelist role="params">
438
<varlistentry><term><parameter>msg</parameter> :</term>
440
</simpara></listitem></varlistentry>
441
</variablelist></refsect2>
442
<refsect2 id="EThread" role="struct" condition="deprecated:">
443
<title>EThread</title>
444
<indexterm zone="EThread" role="deprecated"><primary>EThread</primary></indexterm>
445
<programlisting>typedef struct _EThread EThread;</programlisting>
446
<warning><para><literal>EThread</literal> is deprecated and should not be used in newly-written code.</para></warning>
449
<refsect2 id="e-thread-t" role="enum" condition="deprecated:">
450
<title>enum e_thread_t</title>
451
<indexterm zone="e-thread-t" role="deprecated"><primary>e_thread_t</primary></indexterm>
452
<programlisting>typedef enum {
453
E_THREAD_QUEUE = 0, /* run one by one, until done, if the queue_limit is reached, discard new request */
454
E_THREAD_DROP, /* run one by one, until done, if the queue_limit is reached, discard oldest requests */
455
E_THREAD_NEW /* always run in a new thread, if the queue limit is reached, new requests are
456
stored in the queue until a thread becomes available for it, creating a thread pool */
459
<warning><para><literal>e_thread_t</literal> is deprecated and should not be used in newly-written code.</para></warning>
462
<refsect2 id="EThreadFunc" role="function" condition="deprecated:">
463
<title>EThreadFunc ()</title>
464
<indexterm zone="EThreadFunc" role="deprecated"><primary>EThreadFunc</primary></indexterm>
465
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> (*EThreadFunc) (<parameter><link linkend="EThread"><type>EThread</type></link> *Param1</parameter>,
466
<parameter><link linkend="EMsg"><type>EMsg</type></link> *Param2</parameter>,
467
<parameter><link linkend="gpointer"><type>gpointer</type></link> data</parameter>);</programlisting>
468
<warning><para><literal>EThreadFunc</literal> is deprecated and should not be used in newly-written code.</para></warning>
470
</para><variablelist role="params">
471
<varlistentry><term><parameter>Param1</parameter> :</term>
473
</simpara></listitem></varlistentry>
474
<varlistentry><term><parameter>Param2</parameter> :</term>
476
</simpara></listitem></varlistentry>
477
<varlistentry><term><parameter>data</parameter> :</term>
479
</simpara></listitem></varlistentry>
480
</variablelist></refsect2>
481
<refsect2 id="e-thread-new" role="function" condition="deprecated:">
482
<title>e_thread_new ()</title>
483
<indexterm zone="e-thread-new" role="deprecated"><primary>e_thread_new</primary></indexterm>
484
<programlisting><link linkend="EThread"><returnvalue>EThread</returnvalue></link> * e_thread_new (<parameter><link linkend="e-thread-t"><type>e_thread_t</type></link> type</parameter>);</programlisting>
485
<warning><para><literal>e_thread_new</literal> is deprecated and should not be used in newly-written code.</para></warning>
487
</para><variablelist role="params">
488
<varlistentry><term><parameter>type</parameter> :</term>
490
</simpara></listitem></varlistentry>
491
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
492
</simpara></listitem></varlistentry>
493
</variablelist></refsect2>
494
<refsect2 id="e-thread-destroy" role="function" condition="deprecated:">
495
<title>e_thread_destroy ()</title>
496
<indexterm zone="e-thread-destroy" role="deprecated"><primary>e_thread_destroy</primary></indexterm>
497
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_thread_destroy (<parameter><link linkend="EThread"><type>EThread</type></link> *e</parameter>);</programlisting>
498
<warning><para><literal>e_thread_destroy</literal> is deprecated and should not be used in newly-written code.</para></warning>
500
</para><variablelist role="params">
501
<varlistentry><term><parameter>e</parameter> :</term>
503
</simpara></listitem></varlistentry>
504
</variablelist></refsect2>
505
<refsect2 id="e-thread-set-queue-limit" role="function" condition="deprecated:">
506
<title>e_thread_set_queue_limit ()</title>
507
<indexterm zone="e-thread-set-queue-limit" role="deprecated"><primary>e_thread_set_queue_limit</primary></indexterm>
508
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_thread_set_queue_limit (<parameter><link linkend="EThread"><type>EThread</type></link> *e</parameter>,
509
<parameter><link linkend="gint"><type>gint</type></link> limit</parameter>);</programlisting>
510
<warning><para><literal>e_thread_set_queue_limit</literal> is deprecated and should not be used in newly-written code.</para></warning>
512
</para><variablelist role="params">
513
<varlistentry><term><parameter>e</parameter> :</term>
515
</simpara></listitem></varlistentry>
516
<varlistentry><term><parameter>limit</parameter> :</term>
518
</simpara></listitem></varlistentry>
519
</variablelist></refsect2>
520
<refsect2 id="e-thread-set-msg-lost" role="function" condition="deprecated:">
521
<title>e_thread_set_msg_lost ()</title>
522
<indexterm zone="e-thread-set-msg-lost" role="deprecated"><primary>e_thread_set_msg_lost</primary></indexterm>
523
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_thread_set_msg_lost (<parameter><link linkend="EThread"><type>EThread</type></link> *e</parameter>,
524
<parameter><link linkend="EThreadFunc"><type>EThreadFunc</type></link> destroy</parameter>,
525
<parameter><link linkend="gpointer"><type>gpointer</type></link> data</parameter>);</programlisting>
526
<warning><para><literal>e_thread_set_msg_lost</literal> is deprecated and should not be used in newly-written code.</para></warning>
528
</para><variablelist role="params">
529
<varlistentry><term><parameter>e</parameter> :</term>
531
</simpara></listitem></varlistentry>
532
<varlistentry><term><parameter>destroy</parameter> :</term>
534
</simpara></listitem></varlistentry>
535
<varlistentry><term><parameter>data</parameter> :</term>
537
</simpara></listitem></varlistentry>
538
</variablelist></refsect2>
539
<refsect2 id="e-thread-set-msg-destroy" role="function" condition="deprecated:">
540
<title>e_thread_set_msg_destroy ()</title>
541
<indexterm zone="e-thread-set-msg-destroy" role="deprecated"><primary>e_thread_set_msg_destroy</primary></indexterm>
542
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_thread_set_msg_destroy (<parameter><link linkend="EThread"><type>EThread</type></link> *e</parameter>,
543
<parameter><link linkend="EThreadFunc"><type>EThreadFunc</type></link> destroy</parameter>,
544
<parameter><link linkend="gpointer"><type>gpointer</type></link> data</parameter>);</programlisting>
545
<warning><para><literal>e_thread_set_msg_destroy</literal> is deprecated and should not be used in newly-written code.</para></warning>
547
</para><variablelist role="params">
548
<varlistentry><term><parameter>e</parameter> :</term>
550
</simpara></listitem></varlistentry>
551
<varlistentry><term><parameter>destroy</parameter> :</term>
553
</simpara></listitem></varlistentry>
554
<varlistentry><term><parameter>data</parameter> :</term>
556
</simpara></listitem></varlistentry>
557
</variablelist></refsect2>
558
<refsect2 id="e-thread-set-reply-port" role="function" condition="deprecated:">
559
<title>e_thread_set_reply_port ()</title>
560
<indexterm zone="e-thread-set-reply-port" role="deprecated"><primary>e_thread_set_reply_port</primary></indexterm>
561
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_thread_set_reply_port (<parameter><link linkend="EThread"><type>EThread</type></link> *e</parameter>,
562
<parameter><link linkend="EMsgPort"><type>EMsgPort</type></link> *reply_port</parameter>);</programlisting>
563
<warning><para><literal>e_thread_set_reply_port</literal> is deprecated and should not be used in newly-written code.</para></warning>
565
</para><variablelist role="params">
566
<varlistentry><term><parameter>e</parameter> :</term>
568
</simpara></listitem></varlistentry>
569
<varlistentry><term><parameter>reply_port</parameter> :</term>
571
</simpara></listitem></varlistentry>
572
</variablelist></refsect2>
573
<refsect2 id="e-thread-set-msg-received" role="function" condition="deprecated:">
574
<title>e_thread_set_msg_received ()</title>
575
<indexterm zone="e-thread-set-msg-received" role="deprecated"><primary>e_thread_set_msg_received</primary></indexterm>
576
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_thread_set_msg_received (<parameter><link linkend="EThread"><type>EThread</type></link> *e</parameter>,
577
<parameter><link linkend="EThreadFunc"><type>EThreadFunc</type></link> received</parameter>,
578
<parameter><link linkend="gpointer"><type>gpointer</type></link> data</parameter>);</programlisting>
579
<warning><para><literal>e_thread_set_msg_received</literal> is deprecated and should not be used in newly-written code.</para></warning>
581
</para><variablelist role="params">
582
<varlistentry><term><parameter>e</parameter> :</term>
584
</simpara></listitem></varlistentry>
585
<varlistentry><term><parameter>received</parameter> :</term>
587
</simpara></listitem></varlistentry>
588
<varlistentry><term><parameter>data</parameter> :</term>
590
</simpara></listitem></varlistentry>
591
</variablelist></refsect2>
592
<refsect2 id="e-thread-put" role="function" condition="deprecated:">
593
<title>e_thread_put ()</title>
594
<indexterm zone="e-thread-put" role="deprecated"><primary>e_thread_put</primary></indexterm>
595
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_thread_put (<parameter><link linkend="EThread"><type>EThread</type></link> *e</parameter>,
596
<parameter><link linkend="EMsg"><type>EMsg</type></link> *msg</parameter>);</programlisting>
597
<warning><para><literal>e_thread_put</literal> is deprecated and should not be used in newly-written code.</para></warning>
599
</para><variablelist role="params">
600
<varlistentry><term><parameter>e</parameter> :</term>
602
</simpara></listitem></varlistentry>
603
<varlistentry><term><parameter>msg</parameter> :</term>
605
</simpara></listitem></varlistentry>
606
</variablelist></refsect2>
607
<refsect2 id="e-thread-busy" role="function" condition="deprecated:">
608
<title>e_thread_busy ()</title>
609
<indexterm zone="e-thread-busy" role="deprecated"><primary>e_thread_busy</primary></indexterm>
610
<programlisting><link linkend="gint"><returnvalue>gint</returnvalue></link> e_thread_busy (<parameter><link linkend="EThread"><type>EThread</type></link> *e</parameter>);</programlisting>
611
<warning><para><literal>e_thread_busy</literal> is deprecated and should not be used in newly-written code.</para></warning>
613
</para><variablelist role="params">
614
<varlistentry><term><parameter>e</parameter> :</term>
616
</simpara></listitem></varlistentry>
617
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
618
</simpara></listitem></varlistentry>
619
</variablelist></refsect2>
620
<refsect2 id="EMutex" role="struct" condition="deprecated:">
621
<title>EMutex</title>
622
<indexterm zone="EMutex" role="deprecated"><primary>EMutex</primary></indexterm>
623
<programlisting>typedef struct _EMutex EMutex;</programlisting>
624
<warning><para><literal>EMutex</literal> is deprecated and should not be used in newly-written code.</para></warning>
627
<refsect2 id="e-mutex-t" role="enum" condition="deprecated:">
628
<title>enum e_mutex_t</title>
629
<indexterm zone="e-mutex-t" role="deprecated"><primary>e_mutex_t</primary></indexterm>
630
<programlisting>typedef enum _e_mutex_t {
631
E_MUTEX_SIMPLE, /* == pthread_mutex */
632
E_MUTEX_REC /* recursive mutex */
635
<warning><para><literal>e_mutex_t</literal> is deprecated and should not be used in newly-written code.</para></warning>
638
<refsect2 id="e-mutex-new" role="function" condition="deprecated:">
639
<title>e_mutex_new ()</title>
640
<indexterm zone="e-mutex-new" role="deprecated"><primary>e_mutex_new</primary></indexterm>
641
<programlisting><link linkend="EMutex"><returnvalue>EMutex</returnvalue></link> * e_mutex_new (<parameter><link linkend="e-mutex-t"><type>e_mutex_t</type></link> type</parameter>);</programlisting>
642
<warning><para><literal>e_mutex_new</literal> is deprecated and should not be used in newly-written code.</para></warning>
644
</para><variablelist role="params">
645
<varlistentry><term><parameter>type</parameter> :</term>
647
</simpara></listitem></varlistentry>
648
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
649
</simpara></listitem></varlistentry>
650
</variablelist></refsect2>
651
<refsect2 id="e-mutex-destroy" role="function" condition="deprecated:">
652
<title>e_mutex_destroy ()</title>
653
<indexterm zone="e-mutex-destroy" role="deprecated"><primary>e_mutex_destroy</primary></indexterm>
654
<programlisting><link linkend="gint"><returnvalue>gint</returnvalue></link> e_mutex_destroy (<parameter><link linkend="EMutex"><type>EMutex</type></link> *m</parameter>);</programlisting>
655
<warning><para><literal>e_mutex_destroy</literal> is deprecated and should not be used in newly-written code.</para></warning>
657
</para><variablelist role="params">
658
<varlistentry><term><parameter>m</parameter> :</term>
660
</simpara></listitem></varlistentry>
661
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
662
</simpara></listitem></varlistentry>
663
</variablelist></refsect2>
664
<refsect2 id="e-mutex-lock" role="function" condition="deprecated:">
665
<title>e_mutex_lock ()</title>
666
<indexterm zone="e-mutex-lock" role="deprecated"><primary>e_mutex_lock</primary></indexterm>
667
<programlisting><link linkend="gint"><returnvalue>gint</returnvalue></link> e_mutex_lock (<parameter><link linkend="EMutex"><type>EMutex</type></link> *m</parameter>);</programlisting>
668
<warning><para><literal>e_mutex_lock</literal> is deprecated and should not be used in newly-written code.</para></warning>
670
</para><variablelist role="params">
671
<varlistentry><term><parameter>m</parameter> :</term>
673
</simpara></listitem></varlistentry>
674
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
675
</simpara></listitem></varlistentry>
676
</variablelist></refsect2>
677
<refsect2 id="e-mutex-unlock" role="function" condition="deprecated:">
678
<title>e_mutex_unlock ()</title>
679
<indexterm zone="e-mutex-unlock" role="deprecated"><primary>e_mutex_unlock</primary></indexterm>
680
<programlisting><link linkend="gint"><returnvalue>gint</returnvalue></link> e_mutex_unlock (<parameter><link linkend="EMutex"><type>EMutex</type></link> *m</parameter>);</programlisting>
681
<warning><para><literal>e_mutex_unlock</literal> is deprecated and should not be used in newly-written code.</para></warning>
683
</para><variablelist role="params">
684
<varlistentry><term><parameter>m</parameter> :</term>
686
</simpara></listitem></varlistentry>
687
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
688
</simpara></listitem></varlistentry>
689
</variablelist></refsect2>
690
<refsect2 id="e-mutex-assert-locked" role="function" condition="deprecated:">
691
<title>e_mutex_assert_locked ()</title>
692
<indexterm zone="e-mutex-assert-locked" role="deprecated"><primary>e_mutex_assert_locked</primary></indexterm>
693
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_mutex_assert_locked (<parameter><link linkend="EMutex"><type>EMutex</type></link> *m</parameter>);</programlisting>
694
<warning><para><literal>e_mutex_assert_locked</literal> is deprecated and should not be used in newly-written code.</para></warning>
696
</para><variablelist role="params">
697
<varlistentry><term><parameter>m</parameter> :</term>
699
</simpara></listitem></varlistentry>
700
</variablelist></refsect2>
701
<refsect2 id="e-mutex-cond-wait" role="function" condition="deprecated:">
702
<title>e_mutex_cond_wait ()</title>
703
<indexterm zone="e-mutex-cond-wait" role="deprecated"><primary>e_mutex_cond_wait</primary></indexterm>
704
<programlisting><link linkend="gint"><returnvalue>gint</returnvalue></link> e_mutex_cond_wait (<parameter><link linkend="gpointer"><type>gpointer</type></link> cond</parameter>,
705
<parameter><link linkend="EMutex"><type>EMutex</type></link> *m</parameter>);</programlisting>
706
<warning><para><literal>e_mutex_cond_wait</literal> is deprecated and should not be used in newly-written code.</para></warning>
708
</para><variablelist role="params">
709
<varlistentry><term><parameter>cond</parameter> :</term>
711
</simpara></listitem></varlistentry>
712
<varlistentry><term><parameter>m</parameter> :</term>
714
</simpara></listitem></varlistentry>
715
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
716
</simpara></listitem></varlistentry>
717
</variablelist></refsect2>