← Back to branch summary

~juanje/udev/udev-acls-android

« back to all changes in this revision

Viewing changes to libudev/docs/html/libudev-udev-queue.html

  • Committer: Bazaar Package Importer
  • Author(s): Scott James Remnant
  • Date: 2009-12-02 01:40:55 UTC
  • Revision ID: james.westby@ubuntu.com-20091202014055-g5f7k5z3db7njmlj
Tags: 148~-1
* Update to GIT HEAD:
  - Ignore_device option removed.
  - BUS, SYSFS and ID are now deprecated and result in a warning.
  - IDE device support removed from default rules.
  - New input_id helper, previous uses of the ID_CLASS property on
    input devices should now use the new ID_INPUT_* properties.  This
    is a big part of the Halsectomy of X.org

Show diffs side-by-side

added added

removed removed

Lines of Context:
libudev/docs/html/libudev-udev-queue.html
1
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
 
<html>
3
 
<head>
4
 
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>udev_queue</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
 
<link rel="home" href="index.html" title="libudev Reference Manual">
8
 
<link rel="up" href="ch01.html" title="libudev">
9
 
<link rel="prev" href="libudev-udev-enumerate.html" title="udev_enumerate">
10
 
<link rel="next" href="api-index-full.html" title="API Index">
11
 
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
12
 
<link rel="stylesheet" href="style.css" type="text/css">
13
 
<link rel="chapter" href="ch01.html" title="libudev">
14
 
<link rel="index" href="api-index-full.html" title="API Index">
15
 
</head>
16
 
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
17
 
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
18
 
<tr valign="middle">
19
 
<td><a accesskey="p" href="libudev-udev-enumerate.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
20
 
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
21
 
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
22
 
<th width="100%" align="center">libudev Reference Manual</th>
23
 
<td><a accesskey="n" href="api-index-full.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
24
 
</tr>
25
 
<tr><td colspan="5" class="shortcuts">
26
 
<a href="#libudev-udev-queue.synopsis" class="shortcut">Top</a>
27
 
                 | 
28
 
                <a href="#libudev-udev-queue.description" class="shortcut">Description</a>
29
 
</td></tr>
30
 
</table>
31
 
<div class="refentry" title="udev_queue">
32
 
<a name="libudev-udev-queue"></a><div class="titlepage"></div>
33
 
<div class="refnamediv"><table width="100%"><tr>
34
 
<td valign="top">
35
 
<h2><span class="refentrytitle"><a name="libudev-udev-queue.top_of_page"></a>udev_queue</span></h2>
36
 
<p>udev_queue — access to currently active events</p>
37
 
</td>
38
 
<td valign="top" align="right"></td>
39
 
</tr></table></div>
40
 
<div class="refsynopsisdiv" title="Synopsis">
41
 
<a name="libudev-udev-queue.synopsis"></a><h2>Synopsis</h2>
42
 
<pre class="synopsis">
43
 
struct              <a class="link" href="libudev-udev-queue.html#udev-queue" title="struct udev_queue">udev_queue</a>;
44
 
struct <a class="link" href="libudev-udev-queue.html#udev-queue" title="struct udev_queue">udev_queue</a> * <a class="link" href="libudev-udev-queue.html#udev-queue-ref" title="udev_queue_ref ()">udev_queue_ref</a>                      (struct udev_queue *udev_queue);
45
 
void                <a class="link" href="libudev-udev-queue.html#udev-queue-unref" title="udev_queue_unref ()">udev_queue_unref</a>                    (struct udev_queue *udev_queue);
46
 
struct <a class="link" href="libudev-udev.html#udev" title="struct udev">udev</a> *       <a class="link" href="libudev-udev-queue.html#udev-queue-get-udev" title="udev_queue_get_udev ()">udev_queue_get_udev</a>                 (struct udev_queue *udev_queue);
47
 
struct <a class="link" href="libudev-udev-queue.html#udev-queue" title="struct udev_queue">udev_queue</a> * <a class="link" href="libudev-udev-queue.html#udev-queue-new" title="udev_queue_new ()">udev_queue_new</a>                      (struct udev *udev);
48
 
int                 <a class="link" href="libudev-udev-queue.html#udev-queue-get-udev-is-active" title="udev_queue_get_udev_is_active ()">udev_queue_get_udev_is_active</a>       (struct udev_queue *udev_queue);
49
 
int                 <a class="link" href="libudev-udev-queue.html#udev-queue-get-queue-is-empty" title="udev_queue_get_queue_is_empty ()">udev_queue_get_queue_is_empty</a>       (struct udev_queue *udev_queue);
50
 
int                 <a class="link" href="libudev-udev-queue.html#udev-queue-get-seqnum-is-finished" title="udev_queue_get_seqnum_is_finished ()">udev_queue_get_seqnum_is_finished</a>   (struct udev_queue *udev_queue,
51
 
                                                         long int seqnum);
52
 
int                 <a class="link" href="libudev-udev-queue.html#udev-queue-get-seqnum-sequence-is-finished" title="udev_queue_get_seqnum_sequence_is_finished ()">udev_queue_get_seqnum_sequence_is_finished</a>
53
 
                                                        (struct udev_queue *udev_queue,
54
 
                                                         long int start,
55
 
                                                         long int end);
56
 
struct <a class="link" href="libudev-udev-list.html#udev-list-entry" title="struct udev_list_entry">udev_list_entry</a> * <a class="link" href="libudev-udev-queue.html#udev-queue-get-queued-list-entry" title="udev_queue_get_queued_list_entry ()">udev_queue_get_queued_list_entry</a>
57
 
                                                        (struct udev_queue *udev_queue);
58
 
struct <a class="link" href="libudev-udev-list.html#udev-list-entry" title="struct udev_list_entry">udev_list_entry</a> * <a class="link" href="libudev-udev-queue.html#udev-queue-get-failed-list-entry" title="udev_queue_get_failed_list_entry ()">udev_queue_get_failed_list_entry</a>
59
 
                                                        (struct udev_queue *udev_queue);
60
 
</pre>
61
 
</div>
62
 
<div class="refsect1" title="Description">
63
 
<a name="libudev-udev-queue.description"></a><h2>Description</h2>
64
 
<p>
65
 
The udev daemon processes event asynchronously. All events which do not have
66
 
interdependencies are run in parallel. This exports the current state of the
67
 
event processing queue, and the currently event sequence numbers from the kernel
68
 
and the udev daemon.</p>
69
 
<p>
70
 
</p>
71
 
</div>
72
 
<div class="refsect1" title="Details">
73
 
<a name="libudev-udev-queue.details"></a><h2>Details</h2>
74
 
<div class="refsect2" title="struct udev_queue">
75
 
<a name="udev-queue"></a><h3>struct udev_queue</h3>
76
 
<pre class="programlisting">struct udev_queue;</pre>
77
 
<p>
78
 
Opaque object representing the current event queue in the udev daemon.</p>
79
 
<p>
80
 
</p>
81
 
</div>
82
 
<hr>
83
 
<div class="refsect2" title="udev_queue_ref ()">
84
 
<a name="udev-queue-ref"></a><h3>udev_queue_ref ()</h3>
85
 
<pre class="programlisting">struct <a class="link" href="libudev-udev-queue.html#udev-queue" title="struct udev_queue">udev_queue</a> * udev_queue_ref                      (struct udev_queue *udev_queue);</pre>
86
 
<p>
87
 
Take a reference of a udev queue context.</p>
88
 
<p>
89
 
</p>
90
 
<div class="variablelist"><table border="0">
91
 
<col align="left" valign="top">
92
 
<tbody>
93
 
<tr>
94
 
<td><p><span class="term"><em class="parameter"><code>udev_queue</code></em> :</span></p></td>
95
 
<td> udev queue context
96
 
</td>
97
 
</tr>
98
 
<tr>
99
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
100
 
<td> the same udev queue context.
101
 
</td>
102
 
</tr>
103
 
</tbody>
104
 
</table></div>
105
 
</div>
106
 
<hr>
107
 
<div class="refsect2" title="udev_queue_unref ()">
108
 
<a name="udev-queue-unref"></a><h3>udev_queue_unref ()</h3>
109
 
<pre class="programlisting">void                udev_queue_unref                    (struct udev_queue *udev_queue);</pre>
110
 
<p>
111
 
Drop a reference of a udev queue context. If the refcount reaches zero,
112
 
the resources of the queue context will be released.</p>
113
 
<p>
114
 
</p>
115
 
<div class="variablelist"><table border="0">
116
 
<col align="left" valign="top">
117
 
<tbody><tr>
118
 
<td><p><span class="term"><em class="parameter"><code>udev_queue</code></em> :</span></p></td>
119
 
<td> udev queue context
120
 
</td>
121
 
</tr></tbody>
122
 
</table></div>
123
 
</div>
124
 
<hr>
125
 
<div class="refsect2" title="udev_queue_get_udev ()">
126
 
<a name="udev-queue-get-udev"></a><h3>udev_queue_get_udev ()</h3>
127
 
<pre class="programlisting">struct <a class="link" href="libudev-udev.html#udev" title="struct udev">udev</a> *       udev_queue_get_udev                 (struct udev_queue *udev_queue);</pre>
128
 
<p>
129
 
Retrieve the udev library context the queue context was created with.</p>
130
 
<p>
131
 
</p>
132
 
<div class="variablelist"><table border="0">
133
 
<col align="left" valign="top">
134
 
<tbody>
135
 
<tr>
136
 
<td><p><span class="term"><em class="parameter"><code>udev_queue</code></em> :</span></p></td>
137
 
<td> udev queue context
138
 
</td>
139
 
</tr>
140
 
<tr>
141
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
142
 
<td> the udev library context.
143
 
</td>
144
 
</tr>
145
 
</tbody>
146
 
</table></div>
147
 
</div>
148
 
<hr>
149
 
<div class="refsect2" title="udev_queue_new ()">
150
 
<a name="udev-queue-new"></a><h3>udev_queue_new ()</h3>
151
 
<pre class="programlisting">struct <a class="link" href="libudev-udev-queue.html#udev-queue" title="struct udev_queue">udev_queue</a> * udev_queue_new                      (struct udev *udev);</pre>
152
 
<p>
153
 
The initial refcount is 1, and needs to be decremented to
154
 
release the resources of the udev queue context.</p>
155
 
<p>
156
 
</p>
157
 
<div class="variablelist"><table border="0">
158
 
<col align="left" valign="top">
159
 
<tbody>
160
 
<tr>
161
 
<td><p><span class="term"><em class="parameter"><code>udev</code></em> :</span></p></td>
162
 
<td> udev library context
163
 
</td>
164
 
</tr>
165
 
<tr>
166
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
167
 
<td> the udev queue context, or <a
168
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
169
 
><span class="type">NULL</span></a> on error.
170
 
</td>
171
 
</tr>
172
 
</tbody>
173
 
</table></div>
174
 
</div>
175
 
<hr>
176
 
<div class="refsect2" title="udev_queue_get_udev_is_active ()">
177
 
<a name="udev-queue-get-udev-is-active"></a><h3>udev_queue_get_udev_is_active ()</h3>
178
 
<pre class="programlisting">int                 udev_queue_get_udev_is_active       (struct udev_queue *udev_queue);</pre>
179
 
<p>
180
 
</p>
181
 
<p>
182
 
</p>
183
 
<div class="variablelist"><table border="0">
184
 
<col align="left" valign="top">
185
 
<tbody>
186
 
<tr>
187
 
<td><p><span class="term"><em class="parameter"><code>udev_queue</code></em> :</span></p></td>
188
 
<td> udev queue context
189
 
</td>
190
 
</tr>
191
 
<tr>
192
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
193
 
<td> a flag indicating if udev is active.
194
 
</td>
195
 
</tr>
196
 
</tbody>
197
 
</table></div>
198
 
</div>
199
 
<hr>
200
 
<div class="refsect2" title="udev_queue_get_queue_is_empty ()">
201
 
<a name="udev-queue-get-queue-is-empty"></a><h3>udev_queue_get_queue_is_empty ()</h3>
202
 
<pre class="programlisting">int                 udev_queue_get_queue_is_empty       (struct udev_queue *udev_queue);</pre>
203
 
<p>
204
 
</p>
205
 
<p>
206
 
</p>
207
 
<div class="variablelist"><table border="0">
208
 
<col align="left" valign="top">
209
 
<tbody>
210
 
<tr>
211
 
<td><p><span class="term"><em class="parameter"><code>udev_queue</code></em> :</span></p></td>
212
 
<td> udev queue context
213
 
</td>
214
 
</tr>
215
 
<tr>
216
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
217
 
<td> a flag indicating if udev is currently handling events.
218
 
</td>
219
 
</tr>
220
 
</tbody>
221
 
</table></div>
222
 
</div>
223
 
<hr>
224
 
<div class="refsect2" title="udev_queue_get_seqnum_is_finished ()">
225
 
<a name="udev-queue-get-seqnum-is-finished"></a><h3>udev_queue_get_seqnum_is_finished ()</h3>
226
 
<pre class="programlisting">int                 udev_queue_get_seqnum_is_finished   (struct udev_queue *udev_queue,
227
 
                                                         long int seqnum);</pre>
228
 
<p>
229
 
</p>
230
 
<p>
231
 
</p>
232
 
<div class="variablelist"><table border="0">
233
 
<col align="left" valign="top">
234
 
<tbody>
235
 
<tr>
236
 
<td><p><span class="term"><em class="parameter"><code>udev_queue</code></em> :</span></p></td>
237
 
<td> udev queue context
238
 
</td>
239
 
</tr>
240
 
<tr>
241
 
<td><p><span class="term"><em class="parameter"><code>seqnum</code></em> :</span></p></td>
242
 
<td> sequence number
243
 
</td>
244
 
</tr>
245
 
<tr>
246
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
247
 
<td> a flag indicating if the given sequence number is handled.
248
 
</td>
249
 
</tr>
250
 
</tbody>
251
 
</table></div>
252
 
</div>
253
 
<hr>
254
 
<div class="refsect2" title="udev_queue_get_seqnum_sequence_is_finished ()">
255
 
<a name="udev-queue-get-seqnum-sequence-is-finished"></a><h3>udev_queue_get_seqnum_sequence_is_finished ()</h3>
256
 
<pre class="programlisting">int                 udev_queue_get_seqnum_sequence_is_finished
257
 
                                                        (struct udev_queue *udev_queue,
258
 
                                                         long int start,
259
 
                                                         long int end);</pre>
260
 
<p>
261
 
</p>
262
 
<p>
263
 
</p>
264
 
<div class="variablelist"><table border="0">
265
 
<col align="left" valign="top">
266
 
<tbody>
267
 
<tr>
268
 
<td><p><span class="term"><em class="parameter"><code>udev_queue</code></em> :</span></p></td>
269
 
<td> udev queue context
270
 
</td>
271
 
</tr>
272
 
<tr>
273
 
<td><p><span class="term"><em class="parameter"><code>start</code></em> :</span></p></td>
274
 
<td> first event sequence number
275
 
</td>
276
 
</tr>
277
 
<tr>
278
 
<td><p><span class="term"><em class="parameter"><code>end</code></em> :</span></p></td>
279
 
<td> last event sequence number
280
 
</td>
281
 
</tr>
282
 
<tr>
283
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
284
 
<td> if any of the sequence numbers in the given range is currently active.
285
 
</td>
286
 
</tr>
287
 
</tbody>
288
 
</table></div>
289
 
</div>
290
 
<hr>
291
 
<div class="refsect2" title="udev_queue_get_queued_list_entry ()">
292
 
<a name="udev-queue-get-queued-list-entry"></a><h3>udev_queue_get_queued_list_entry ()</h3>
293
 
<pre class="programlisting">struct <a class="link" href="libudev-udev-list.html#udev-list-entry" title="struct udev_list_entry">udev_list_entry</a> * udev_queue_get_queued_list_entry
294
 
                                                        (struct udev_queue *udev_queue);</pre>
295
 
<p>
296
 
</p>
297
 
<p>
298
 
</p>
299
 
<div class="variablelist"><table border="0">
300
 
<col align="left" valign="top">
301
 
<tbody>
302
 
<tr>
303
 
<td><p><span class="term"><em class="parameter"><code>udev_queue</code></em> :</span></p></td>
304
 
<td> udev queue context
305
 
</td>
306
 
</tr>
307
 
<tr>
308
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
309
 
<td> the first entry of the list of queued events.
310
 
</td>
311
 
</tr>
312
 
</tbody>
313
 
</table></div>
314
 
</div>
315
 
<hr>
316
 
<div class="refsect2" title="udev_queue_get_failed_list_entry ()">
317
 
<a name="udev-queue-get-failed-list-entry"></a><h3>udev_queue_get_failed_list_entry ()</h3>
318
 
<pre class="programlisting">struct <a class="link" href="libudev-udev-list.html#udev-list-entry" title="struct udev_list_entry">udev_list_entry</a> * udev_queue_get_failed_list_entry
319
 
                                                        (struct udev_queue *udev_queue);</pre>
320
 
<p>
321
 
</p>
322
 
<p>
323
 
</p>
324
 
<div class="variablelist"><table border="0">
325
 
<col align="left" valign="top">
326
 
<tbody>
327
 
<tr>
328
 
<td><p><span class="term"><em class="parameter"><code>udev_queue</code></em> :</span></p></td>
329
 
<td> udev queue context
330
 
</td>
331
 
</tr>
332
 
<tr>
333
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
334
 
<td> the first entry of the list of recorded failed events.
335
 
</td>
336
 
</tr>
337
 
</tbody>
338
 
</table></div>
339
 
</div>
340
 
</div>
341
 
</div>
342
 
<div class="footer">
343
 
<hr>
344
 
          Generated by GTK-Doc V1.11</div>
345
 
</body>
346
 
</html>