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
|
<?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-async">
<refmeta>
<refentrytitle role="top_of_page" id="libprelude-prelude-async.top_of_page">prelude-async</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBPRELUDE Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>prelude-async</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="libprelude-prelude-async.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
enum <link linkend="prelude-async-flags-t">prelude_async_flags_t</link>;
<link linkend="void">void</link> (<link linkend="prelude-async-callback-t">*prelude_async_callback_t</link>) (<link linkend="void">void</link> *object,
<link linkend="void">void</link> *data);
#define <link linkend="PRELUDE-ASYNC-OBJECT:CAPS">PRELUDE_ASYNC_OBJECT</link>
<link linkend="prelude-async-object-t">prelude_async_object_t</link>;
<link linkend="int">int</link> <link linkend="prelude-async-init">prelude_async_init</link> (void);
<link linkend="prelude-async-flags-t">prelude_async_flags_t</link> <link linkend="prelude-async-get-flags">prelude_async_get_flags</link> (void);
<link linkend="void">void</link> <link linkend="prelude-async-set-flags">prelude_async_set_flags</link> (<link linkend="prelude-async-flags-t">prelude_async_flags_t</link> flags);
<link linkend="void">void</link> <link linkend="prelude-async-add">prelude_async_add</link> (<link linkend="prelude-async-object-t">prelude_async_object_t</link> *obj);
<link linkend="void">void</link> <link linkend="prelude-async-del">prelude_async_del</link> (<link linkend="prelude-async-object-t">prelude_async_object_t</link> *obj);
<link linkend="void">void</link> <link linkend="prelude-async-exit">prelude_async_exit</link> (void);
</synopsis>
</refsynopsisdiv>
<refsect1 id="libprelude-prelude-async.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="libprelude-prelude-async.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="prelude-async-flags-t" role="enum">
<title>enum prelude_async_flags_t</title>
<indexterm zone="prelude-async-flags-t"><primary>prelude_async_flags_t</primary></indexterm><programlisting>typedef enum {
PRELUDE_ASYNC_FLAGS_TIMER = 0x01
} prelude_async_flags_t;
</programlisting>
<para>
Provides asynchronous timer, meaning the user specified callback function will be called automatically, from an asynchronous thread.
If you use this flags, you don't need to call <link linkend="prelude-wake-up-timer"><function>prelude_wake_up_timer()</function></link> anymore.
</para></refsect2>
<refsect2 id="prelude-async-callback-t" role="function">
<title>prelude_async_callback_t ()</title>
<indexterm zone="prelude-async-callback-t"><primary>prelude_async_callback_t</primary></indexterm><programlisting><link linkend="void">void</link> (*prelude_async_callback_t) (<link linkend="void">void</link> *object,
<link linkend="void">void</link> *data);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="PRELUDE-ASYNC-OBJECT:CAPS" role="macro">
<title>PRELUDE_ASYNC_OBJECT</title>
<indexterm zone="PRELUDE-ASYNC-OBJECT:CAPS"><primary>PRELUDE_ASYNC_OBJECT</primary></indexterm><programlisting>#define PRELUDE_ASYNC_OBJECT</programlisting>
<para>
</para></refsect2>
<refsect2 id="prelude-async-object-t" role="struct">
<title>prelude_async_object_t</title>
<indexterm zone="prelude-async-object-t"><primary>prelude_async_object_t</primary></indexterm><programlisting>typedef struct {
PRELUDE_ASYNC_OBJECT;
} prelude_async_object_t;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="prelude-async-init" role="function">
<title>prelude_async_init ()</title>
<indexterm zone="prelude-async-init"><primary>prelude_async_init</primary></indexterm><programlisting><link linkend="int">int</link> prelude_async_init (void);</programlisting>
<para>
Initialize the asynchronous subsystem.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> 0 on success, -1 if an error occured.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="prelude-async-get-flags" role="function">
<title>prelude_async_get_flags ()</title>
<indexterm zone="prelude-async-get-flags"><primary>prelude_async_get_flags</primary></indexterm><programlisting><link linkend="prelude-async-flags-t">prelude_async_flags_t</link> prelude_async_get_flags (void);</programlisting>
<para>
Retrieves flags from the asynchronous subsystem</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> asynchronous flags
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="prelude-async-set-flags" role="function">
<title>prelude_async_set_flags ()</title>
<indexterm zone="prelude-async-set-flags"><primary>prelude_async_set_flags</primary></indexterm><programlisting><link linkend="void">void</link> prelude_async_set_flags (<link linkend="prelude-async-flags-t">prelude_async_flags_t</link> flags);</programlisting>
<para>
Sets flags to the asynchronous subsystem.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>flags</parameter> :</term>
<listitem><simpara> flags you want to set
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="prelude-async-add" role="function">
<title>prelude_async_add ()</title>
<indexterm zone="prelude-async-add"><primary>prelude_async_add</primary></indexterm><programlisting><link linkend="void">void</link> prelude_async_add (<link linkend="prelude-async-object-t">prelude_async_object_t</link> *obj);</programlisting>
<para>
Adds <parameter>obj</parameter> to the asynchronous processing list.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>obj</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="prelude-async-t"><type>prelude_async_t</type></link> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="prelude-async-del" role="function">
<title>prelude_async_del ()</title>
<indexterm zone="prelude-async-del"><primary>prelude_async_del</primary></indexterm><programlisting><link linkend="void">void</link> prelude_async_del (<link linkend="prelude-async-object-t">prelude_async_object_t</link> *obj);</programlisting>
<para>
Deletes <parameter>obj</parameter> from the asynchronous processing list.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>obj</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="prelude-async-t"><type>prelude_async_t</type></link> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="prelude-async-exit" role="function">
<title>prelude_async_exit ()</title>
<indexterm zone="prelude-async-exit"><primary>prelude_async_exit</primary></indexterm><programlisting><link linkend="void">void</link> prelude_async_exit (void);</programlisting>
<para>
</para></refsect2>
</refsect1>
</refentry>
|