← Back to branch summary

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

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Pierre Chifflier
  • Date: 2008-04-28 15:23:30 UTC
  • mfrom: (1.1.9 upstream)
  • Revision ID: james.westby@ubuntu.com-20080428152330-su7zlfscjjeh30ig
Tags: 0.9.17.1-1
New upstream release (remove debug output)

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/api/xml/prelude-async.xml
3
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
4
<refentry id="libprelude-prelude-async">
5
5
<refmeta>
6
 
<refentrytitle role="top_of_page">prelude-async</refentrytitle>
 
6
<refentrytitle role="top_of_page" id="libprelude-prelude-async.top_of_page">prelude-async</refentrytitle>
7
7
<manvolnum>3</manvolnum>
8
8
<refmiscinfo>LIBPRELUDE Library</refmiscinfo>
9
9
</refmeta>
14
14
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
15
15
</refnamediv>
16
16
 
17
 
<refsynopsisdiv role="synopsis">
 
17
<refsynopsisdiv id="libprelude-prelude-async.synopsis" role="synopsis">
18
18
<title role="synopsis.title">Synopsis</title>
19
19
 
20
20
<synopsis>
21
 
 
22
 
 
23
 
 
24
21
enum                <link linkend="prelude-async-flags-t">prelude_async_flags_t</link>;
25
22
<link linkend="void">void</link>                (<link linkend="prelude-async-callback-t">*prelude_async_callback_t</link>)         (<link linkend="void">void</link> *object,
26
23
                                                         <link linkend="void">void</link> *data);
43
40
 
44
41
 
45
42
 
46
 
<refsect1 role="desc">
 
43
<refsect1 id="libprelude-prelude-async.description" role="desc">
47
44
<title role="desc.title">Description</title>
48
45
<para>
49
46
 
50
47
</para>
51
48
</refsect1>
52
49
 
53
 
<refsect1 role="details">
 
50
<refsect1 id="libprelude-prelude-async.details" role="details">
54
51
<title role="details.title">Details</title>
55
 
<refsect2>
56
 
<title><anchor id="prelude-async-flags-t" role="enum"/>enum prelude_async_flags_t</title>
57
 
<indexterm><primary>prelude_async_flags_t</primary></indexterm><programlisting>typedef enum {
 
52
<refsect2 id="prelude-async-flags-t" role="enum">
 
53
<title>enum prelude_async_flags_t</title>
 
54
<indexterm zone="prelude-async-flags-t"><primary>prelude_async_flags_t</primary></indexterm><programlisting>typedef enum {
58
55
        PRELUDE_ASYNC_FLAGS_TIMER   = 0x01
59
56
} prelude_async_flags_t;
60
57
</programlisting>
62
59
Provides asynchronous timer, meaning the user specified callback function will be called automatically, from an asynchronous thread.
63
60
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.
64
61
</para></refsect2>
65
 
<refsect2>
66
 
<title><anchor id="prelude-async-callback-t" role="function"/>prelude_async_callback_t ()</title>
67
 
<indexterm><primary>prelude_async_callback_t</primary></indexterm><programlisting><link linkend="void">void</link>                (*prelude_async_callback_t)         (<link linkend="void">void</link> *object,
 
62
<refsect2 id="prelude-async-callback-t" role="function">
 
63
<title>prelude_async_callback_t ()</title>
 
64
<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,
68
65
                                                         <link linkend="void">void</link> *data);</programlisting>
69
66
<para>
70
67
 
78
75
 
79
76
</simpara></listitem></varlistentry>
80
77
</variablelist></refsect2>
81
 
<refsect2>
82
 
<title><anchor id="PRELUDE-ASYNC-OBJECT:CAPS" role="macro"/>PRELUDE_ASYNC_OBJECT</title>
83
 
<indexterm><primary>PRELUDE_ASYNC_OBJECT</primary></indexterm><programlisting>#define             PRELUDE_ASYNC_OBJECT</programlisting>
 
78
<refsect2 id="PRELUDE-ASYNC-OBJECT:CAPS" role="macro">
 
79
<title>PRELUDE_ASYNC_OBJECT</title>
 
80
<indexterm zone="PRELUDE-ASYNC-OBJECT:CAPS"><primary>PRELUDE_ASYNC_OBJECT</primary></indexterm><programlisting>#define             PRELUDE_ASYNC_OBJECT</programlisting>
84
81
<para>
85
82
 
86
83
</para></refsect2>
87
 
<refsect2>
88
 
<title><anchor id="prelude-async-object-t" role="struct"/>prelude_async_object_t</title>
89
 
<indexterm><primary>prelude_async_object_t</primary></indexterm><programlisting>typedef struct {
 
84
<refsect2 id="prelude-async-object-t" role="struct">
 
85
<title>prelude_async_object_t</title>
 
86
<indexterm zone="prelude-async-object-t"><primary>prelude_async_object_t</primary></indexterm><programlisting>typedef struct {
90
87
        PRELUDE_ASYNC_OBJECT;
91
88
} prelude_async_object_t;
92
89
</programlisting>
93
90
<para>
94
91
 
95
92
</para></refsect2>
96
 
<refsect2>
97
 
<title><anchor id="prelude-async-init" role="function"/>prelude_async_init ()</title>
98
 
<indexterm><primary>prelude_async_init</primary></indexterm><programlisting><link linkend="int">int</link>                 prelude_async_init                  (void);</programlisting>
 
93
<refsect2 id="prelude-async-init" role="function">
 
94
<title>prelude_async_init ()</title>
 
95
<indexterm zone="prelude-async-init"><primary>prelude_async_init</primary></indexterm><programlisting><link linkend="int">int</link>                 prelude_async_init                  (void);</programlisting>
99
96
<para>
100
97
Initialize the asynchronous subsystem.</para>
101
98
<para>
104
101
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> 0 on success, -1 if an error occured.
105
102
</simpara></listitem></varlistentry>
106
103
</variablelist></refsect2>
107
 
<refsect2>
108
 
<title><anchor id="prelude-async-get-flags" role="function"/>prelude_async_get_flags ()</title>
109
 
<indexterm><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>
 
104
<refsect2 id="prelude-async-get-flags" role="function">
 
105
<title>prelude_async_get_flags ()</title>
 
106
<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>
110
107
<para>
111
108
Retrieves flags from the asynchronous subsystem</para>
112
109
<para>
115
112
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> asynchronous flags
116
113
</simpara></listitem></varlistentry>
117
114
</variablelist></refsect2>
118
 
<refsect2>
119
 
<title><anchor id="prelude-async-set-flags" role="function"/>prelude_async_set_flags ()</title>
120
 
<indexterm><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>
 
115
<refsect2 id="prelude-async-set-flags" role="function">
 
116
<title>prelude_async_set_flags ()</title>
 
117
<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>
121
118
<para>
122
119
Sets flags to the asynchronous subsystem.</para>
123
120
<para>
127
124
<listitem><simpara> flags you want to set
128
125
</simpara></listitem></varlistentry>
129
126
</variablelist></refsect2>
130
 
<refsect2>
131
 
<title><anchor id="prelude-async-add" role="function"/>prelude_async_add ()</title>
132
 
<indexterm><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>
 
127
<refsect2 id="prelude-async-add" role="function">
 
128
<title>prelude_async_add ()</title>
 
129
<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>
133
130
<para>
134
131
Adds <parameter>obj</parameter> to the asynchronous processing list.</para>
135
132
<para>
139
136
<listitem><simpara> Pointer to a <link linkend="prelude-async-t"><type>prelude_async_t</type></link> object.
140
137
</simpara></listitem></varlistentry>
141
138
</variablelist></refsect2>
142
 
<refsect2>
143
 
<title><anchor id="prelude-async-del" role="function"/>prelude_async_del ()</title>
144
 
<indexterm><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>
 
139
<refsect2 id="prelude-async-del" role="function">
 
140
<title>prelude_async_del ()</title>
 
141
<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>
145
142
<para>
146
143
Deletes <parameter>obj</parameter> from the asynchronous processing list.</para>
147
144
<para>
151
148
<listitem><simpara> Pointer to a <link linkend="prelude-async-t"><type>prelude_async_t</type></link> object.
152
149
</simpara></listitem></varlistentry>
153
150
</variablelist></refsect2>
154
 
<refsect2>
155
 
<title><anchor id="prelude-async-exit" role="function"/>prelude_async_exit ()</title>
156
 
<indexterm><primary>prelude_async_exit</primary></indexterm><programlisting><link linkend="void">void</link>                prelude_async_exit                  (void);</programlisting>
 
151
<refsect2 id="prelude-async-exit" role="function">
 
152
<title>prelude_async_exit ()</title>
 
153
<indexterm zone="prelude-async-exit"><primary>prelude_async_exit</primary></indexterm><programlisting><link linkend="void">void</link>                prelude_async_exit                  (void);</programlisting>
157
154
<para>
158
155
 
159
156
</para></refsect2>