← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/api/html/libprelude-prelude-async.html

  • 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/html/libprelude-prelude-async.html
1
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
2
<html>
3
3
<head>
4
 
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>prelude-async</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
7
<link rel="start" href="index.html" title="Prelude library Reference Manual">
8
8
<link rel="up" href="ch04.html" title="Others">
9
9
<link rel="prev" href="libprelude-prelude-failover.html" title="prelude-failover">
10
10
<link rel="next" href="libprelude-prelude-list.html" title="prelude-list">
11
 
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
 
<link rel="part" href="pt01.html" title="Part&#160;I.&#160;Using libprelude to interoperate with prelude-manager">
14
 
<link rel="part" href="pt02.html" title="Part&#160;II.&#160;Sending events with libprelude">
 
13
<link rel="part" href="pt01.html" title="Part I. Using libprelude to interoperate with prelude-manager">
 
14
<link rel="part" href="pt02.html" title="Part II. Sending events with libprelude">
15
15
<link rel="chapter" href="ch01.html" title="The low level IDMEF API">
16
16
<link rel="chapter" href="ch02.html" title="The high level IDMEF API">
17
 
<link rel="part" href="pt03.html" title="Part&#160;III.&#160;Reading events from the collector">
18
 
<link rel="part" href="pt04.html" title="Part&#160;IV.&#160;Filtering operation on IDMEF messages">
 
17
<link rel="part" href="pt03.html" title="Part III. Reading events from the collector">
 
18
<link rel="part" href="pt04.html" title="Part IV. Filtering operation on IDMEF messages">
19
19
<link rel="chapter" href="ch03.html" title="Utility functions">
20
20
<link rel="chapter" href="ch04.html" title="Others">
21
21
</head>
28
28
<th width="100%" align="center">Prelude library Reference Manual</th>
29
29
<td><a accesskey="n" href="libprelude-prelude-list.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
30
30
</tr>
31
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id345719" class="shortcut">Top</a>
32
 
                  &#160;|&#160;
33
 
                  <a href="#id396949" class="shortcut">Description</a></nobr></td></tr>
 
31
<tr><td colspan="5" class="shortcuts"><nobr><a href="#libprelude-prelude-async.synopsis" class="shortcut">Top</a>
 
32
                   | 
 
33
                  <a href="#libprelude-prelude-async.description" class="shortcut">Description</a></nobr></td></tr>
34
34
</table>
35
35
<div class="refentry" lang="en">
36
36
<a name="libprelude-prelude-async"></a><div class="titlepage"></div>
37
37
<div class="refnamediv"><table width="100%"><tr>
38
38
<td valign="top">
39
 
<h2>
40
 
<a name="id345719"></a><span class="refentrytitle">prelude-async</span>
41
 
</h2>
 
39
<h2><span class="refentrytitle"><a name="libprelude-prelude-async.top_of_page"></a>prelude-async</span></h2>
42
40
<p>prelude-async</p>
43
41
</td>
44
42
<td valign="top" align="right"></td>
45
43
</tr></table></div>
46
44
<div class="refsynopsisdiv">
47
 
<h2>Synopsis</h2>
 
45
<a name="libprelude-prelude-async.synopsis"></a><h2>Synopsis</h2>
48
46
<pre class="synopsis">
49
 
 
50
 
 
51
 
 
52
 
enum                <a href="libprelude-prelude-async.html#prelude-async-flags-t">prelude_async_flags_t</a>;
53
 
void                (<a href="libprelude-prelude-async.html#prelude-async-callback-t">*prelude_async_callback_t</a>)         (void *object,
 
47
enum                <a class="link" href="libprelude-prelude-async.html#prelude-async-flags-t" title="enum prelude_async_flags_t">prelude_async_flags_t</a>;
 
48
void                (<a class="link" href="libprelude-prelude-async.html#prelude-async-callback-t" title="prelude_async_callback_t ()">*prelude_async_callback_t</a>)         (void *object,
54
49
                                                         void *data);
55
 
#define             <a href="libprelude-prelude-async.html#PRELUDE-ASYNC-OBJECT:CAPS">PRELUDE_ASYNC_OBJECT</a>
56
 
                    <a href="libprelude-prelude-async.html#prelude-async-object-t">prelude_async_object_t</a>;
57
 
int                 <a href="libprelude-prelude-async.html#prelude-async-init">prelude_async_init</a>                  (void);
58
 
<a href="libprelude-prelude-async.html#prelude-async-flags-t">prelude_async_flags_t</a> <a href="libprelude-prelude-async.html#prelude-async-get-flags">prelude_async_get_flags</a>           (void);
59
 
void                <a href="libprelude-prelude-async.html#prelude-async-set-flags">prelude_async_set_flags</a>             (<a href="libprelude-prelude-async.html#prelude-async-flags-t">prelude_async_flags_t</a> flags);
60
 
void                <a href="libprelude-prelude-async.html#prelude-async-add">prelude_async_add</a>                   (<a href="libprelude-prelude-async.html#prelude-async-object-t">prelude_async_object_t</a> *obj);
61
 
void                <a href="libprelude-prelude-async.html#prelude-async-del">prelude_async_del</a>                   (<a href="libprelude-prelude-async.html#prelude-async-object-t">prelude_async_object_t</a> *obj);
62
 
void                <a href="libprelude-prelude-async.html#prelude-async-exit">prelude_async_exit</a>                  (void);
 
50
#define             <a class="link" href="libprelude-prelude-async.html#PRELUDE-ASYNC-OBJECT:CAPS" title="PRELUDE_ASYNC_OBJECT">PRELUDE_ASYNC_OBJECT</a>
 
51
                    <a class="link" href="libprelude-prelude-async.html#prelude-async-object-t" title="prelude_async_object_t">prelude_async_object_t</a>;
 
52
int                 <a class="link" href="libprelude-prelude-async.html#prelude-async-init" title="prelude_async_init ()">prelude_async_init</a>                  (void);
 
53
<a class="link" href="libprelude-prelude-async.html#prelude-async-flags-t" title="enum prelude_async_flags_t">prelude_async_flags_t</a> <a class="link" href="libprelude-prelude-async.html#prelude-async-get-flags" title="prelude_async_get_flags ()">prelude_async_get_flags</a>           (void);
 
54
void                <a class="link" href="libprelude-prelude-async.html#prelude-async-set-flags" title="prelude_async_set_flags ()">prelude_async_set_flags</a>             (<a class="link" href="libprelude-prelude-async.html#prelude-async-flags-t" title="enum prelude_async_flags_t">prelude_async_flags_t</a> flags);
 
55
void                <a class="link" href="libprelude-prelude-async.html#prelude-async-add" title="prelude_async_add ()">prelude_async_add</a>                   (<a class="link" href="libprelude-prelude-async.html#prelude-async-object-t" title="prelude_async_object_t">prelude_async_object_t</a> *obj);
 
56
void                <a class="link" href="libprelude-prelude-async.html#prelude-async-del" title="prelude_async_del ()">prelude_async_del</a>                   (<a class="link" href="libprelude-prelude-async.html#prelude-async-object-t" title="prelude_async_object_t">prelude_async_object_t</a> *obj);
 
57
void                <a class="link" href="libprelude-prelude-async.html#prelude-async-exit" title="prelude_async_exit ()">prelude_async_exit</a>                  (void);
63
58
</pre>
64
59
</div>
65
60
<div class="refsect1" lang="en">
66
 
<a name="id396949"></a><h2>Description</h2>
 
61
<a name="libprelude-prelude-async.description"></a><h2>Description</h2>
67
62
<p>
68
63
 
69
64
</p>
70
65
</div>
71
66
<div class="refsect1" lang="en">
72
 
<a name="id396965"></a><h2>Details</h2>
 
67
<a name="libprelude-prelude-async.details"></a><h2>Details</h2>
73
68
<div class="refsect2" lang="en">
74
 
<a name="id396976"></a><h3>
75
 
<a name="prelude-async-flags-t"></a>enum prelude_async_flags_t</h3>
76
 
<a class="indexterm" name="id412832"></a><pre class="programlisting">typedef enum {
 
69
<a name="prelude-async-flags-t"></a><h3>enum prelude_async_flags_t</h3>
 
70
<pre class="programlisting">typedef enum {
77
71
        PRELUDE_ASYNC_FLAGS_TIMER   = 0x01
78
72
} prelude_async_flags_t;
79
73
</pre>
84
78
</div>
85
79
<hr>
86
80
<div class="refsect2" lang="en">
87
 
<a name="id412858"></a><h3>
88
 
<a name="prelude-async-callback-t"></a>prelude_async_callback_t ()</h3>
89
 
<a class="indexterm" name="id412869"></a><pre class="programlisting">void                (*prelude_async_callback_t)         (void *object,
 
81
<a name="prelude-async-callback-t"></a><h3>prelude_async_callback_t ()</h3>
 
82
<pre class="programlisting">void                (*prelude_async_callback_t)         (void *object,
90
83
                                                         void *data);</pre>
91
84
<p>
92
85
 
95
88
<col align="left" valign="top">
96
89
<tbody>
97
90
<tr>
98
 
<td><span class="term"><em class="parameter"><code>object</code></em>&#160;:</span></td>
 
91
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
99
92
<td>
100
93
</td>
101
94
</tr>
102
95
<tr>
103
 
<td><span class="term"><em class="parameter"><code>data</code></em>&#160;:</span></td>
 
96
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
104
97
<td>
105
98
 
106
99
 
111
104
</div>
112
105
<hr>
113
106
<div class="refsect2" lang="en">
114
 
<a name="id441192"></a><h3>
115
 
<a name="PRELUDE-ASYNC-OBJECT:CAPS"></a>PRELUDE_ASYNC_OBJECT</h3>
116
 
<a class="indexterm" name="id441204"></a><pre class="programlisting">#define             PRELUDE_ASYNC_OBJECT</pre>
 
107
<a name="PRELUDE-ASYNC-OBJECT:CAPS"></a><h3>PRELUDE_ASYNC_OBJECT</h3>
 
108
<pre class="programlisting">#define             PRELUDE_ASYNC_OBJECT</pre>
117
109
<p>
118
110
 
119
111
</p>
120
112
</div>
121
113
<hr>
122
114
<div class="refsect2" lang="en">
123
 
<a name="id441219"></a><h3>
124
 
<a name="prelude-async-object-t"></a>prelude_async_object_t</h3>
125
 
<a class="indexterm" name="id441231"></a><pre class="programlisting">typedef struct {
 
115
<a name="prelude-async-object-t"></a><h3>prelude_async_object_t</h3>
 
116
<pre class="programlisting">typedef struct {
126
117
        PRELUDE_ASYNC_OBJECT;
127
118
} prelude_async_object_t;
128
119
</pre>
132
123
</div>
133
124
<hr>
134
125
<div class="refsect2" lang="en">
135
 
<a name="id413114"></a><h3>
136
 
<a name="prelude-async-init"></a>prelude_async_init ()</h3>
137
 
<a class="indexterm" name="id413126"></a><pre class="programlisting">int                 prelude_async_init                  (void);</pre>
 
126
<a name="prelude-async-init"></a><h3>prelude_async_init ()</h3>
 
127
<pre class="programlisting">int                 prelude_async_init                  (void);</pre>
138
128
<p>
139
129
Initialize the asynchronous subsystem.</p>
140
130
<p>
143
133
<div class="variablelist"><table border="0">
144
134
<col align="left" valign="top">
145
135
<tbody><tr>
146
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
136
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
147
137
<td> 0 on success, -1 if an error occured.
148
138
</td>
149
139
</tr></tbody>
151
141
</div>
152
142
<hr>
153
143
<div class="refsect2" lang="en">
154
 
<a name="id413164"></a><h3>
155
 
<a name="prelude-async-get-flags"></a>prelude_async_get_flags ()</h3>
156
 
<a class="indexterm" name="id413176"></a><pre class="programlisting"><a href="libprelude-prelude-async.html#prelude-async-flags-t">prelude_async_flags_t</a> prelude_async_get_flags           (void);</pre>
 
144
<a name="prelude-async-get-flags"></a><h3>prelude_async_get_flags ()</h3>
 
145
<pre class="programlisting"><a class="link" href="libprelude-prelude-async.html#prelude-async-flags-t" title="enum prelude_async_flags_t">prelude_async_flags_t</a> prelude_async_get_flags           (void);</pre>
157
146
<p>
158
147
Retrieves flags from the asynchronous subsystem</p>
159
148
<p>
162
151
<div class="variablelist"><table border="0">
163
152
<col align="left" valign="top">
164
153
<tbody><tr>
165
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
154
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
166
155
<td> asynchronous flags
167
156
</td>
168
157
</tr></tbody>
170
159
</div>
171
160
<hr>
172
161
<div class="refsect2" lang="en">
173
 
<a name="id430570"></a><h3>
174
 
<a name="prelude-async-set-flags"></a>prelude_async_set_flags ()</h3>
175
 
<a class="indexterm" name="id430580"></a><pre class="programlisting">void                prelude_async_set_flags             (<a href="libprelude-prelude-async.html#prelude-async-flags-t">prelude_async_flags_t</a> flags);</pre>
 
162
<a name="prelude-async-set-flags"></a><h3>prelude_async_set_flags ()</h3>
 
163
<pre class="programlisting">void                prelude_async_set_flags             (<a class="link" href="libprelude-prelude-async.html#prelude-async-flags-t" title="enum prelude_async_flags_t">prelude_async_flags_t</a> flags);</pre>
176
164
<p>
177
165
Sets flags to the asynchronous subsystem.</p>
178
166
<p>
181
169
<div class="variablelist"><table border="0">
182
170
<col align="left" valign="top">
183
171
<tbody><tr>
184
 
<td><span class="term"><em class="parameter"><code>flags</code></em>&#160;:</span></td>
 
172
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
185
173
<td> flags you want to set
186
174
</td>
187
175
</tr></tbody>
189
177
</div>
190
178
<hr>
191
179
<div class="refsect2" lang="en">
192
 
<a name="id430629"></a><h3>
193
 
<a name="prelude-async-add"></a>prelude_async_add ()</h3>
194
 
<a class="indexterm" name="id430641"></a><pre class="programlisting">void                prelude_async_add                   (<a href="libprelude-prelude-async.html#prelude-async-object-t">prelude_async_object_t</a> *obj);</pre>
 
180
<a name="prelude-async-add"></a><h3>prelude_async_add ()</h3>
 
181
<pre class="programlisting">void                prelude_async_add                   (<a class="link" href="libprelude-prelude-async.html#prelude-async-object-t" title="prelude_async_object_t">prelude_async_object_t</a> *obj);</pre>
195
182
<p>
196
183
Adds <em class="parameter"><code>obj</code></em> to the asynchronous processing list.</p>
197
184
<p>
200
187
<div class="variablelist"><table border="0">
201
188
<col align="left" valign="top">
202
189
<tbody><tr>
203
 
<td><span class="term"><em class="parameter"><code>obj</code></em>&#160;:</span></td>
 
190
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
204
191
<td> Pointer to a <span class="type">prelude_async_t</span> object.
205
192
</td>
206
193
</tr></tbody>
208
195
</div>
209
196
<hr>
210
197
<div class="refsect2" lang="en">
211
 
<a name="id430702"></a><h3>
212
 
<a name="prelude-async-del"></a>prelude_async_del ()</h3>
213
 
<a class="indexterm" name="id430714"></a><pre class="programlisting">void                prelude_async_del                   (<a href="libprelude-prelude-async.html#prelude-async-object-t">prelude_async_object_t</a> *obj);</pre>
 
198
<a name="prelude-async-del"></a><h3>prelude_async_del ()</h3>
 
199
<pre class="programlisting">void                prelude_async_del                   (<a class="link" href="libprelude-prelude-async.html#prelude-async-object-t" title="prelude_async_object_t">prelude_async_object_t</a> *obj);</pre>
214
200
<p>
215
201
Deletes <em class="parameter"><code>obj</code></em> from the asynchronous processing list.</p>
216
202
<p>
219
205
<div class="variablelist"><table border="0">
220
206
<col align="left" valign="top">
221
207
<tbody><tr>
222
 
<td><span class="term"><em class="parameter"><code>obj</code></em>&#160;:</span></td>
 
208
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
223
209
<td> Pointer to a <span class="type">prelude_async_t</span> object.
224
210
</td>
225
211
</tr></tbody>
227
213
</div>
228
214
<hr>
229
215
<div class="refsect2" lang="en">
230
 
<a name="id461621"></a><h3>
231
 
<a name="prelude-async-exit"></a>prelude_async_exit ()</h3>
232
 
<a class="indexterm" name="id461633"></a><pre class="programlisting">void                prelude_async_exit                  (void);</pre>
 
216
<a name="prelude-async-exit"></a><h3>prelude_async_exit ()</h3>
 
217
<pre class="programlisting">void                prelude_async_exit                  (void);</pre>
233
218
<p>
234
219
 
235
220
</p>
236
221
</div>
237
222
</div>
238
223
</div>
 
224
<div class="footer">
 
225
<hr>
 
226
          Generated by GTK-Doc V1.10</div>
239
227
</body>
240
228
</html>