← Back to branch summary

~ubuntu-branches/ubuntu/lucid/xenomai/lucid

« back to all changes in this revision

Viewing changes to doc/generated/html/api/group__select.html

  • Committer: Bazaar Package Importer
  • Author(s): Andres Rodriguez
  • Date: 2009-06-24 22:17:01 UTC
  • mfrom: (3.1.2 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090624221701-mwnah8aj90zmp6uj
Tags: 2.4.8-2ubuntu1
https://launchpad.net/bugs/391918
* Merge from debian unstable (LP: #391918), remaining changes:
  - Add lpia to supported architectures.
  - debian/rules: Create file for debhelper to pick up, use debhelper to
    install it.
  - debian/libxenomai1.dirs: Do not create directory.
  - debian/libxenomai1.preinst: Remove symlink on upgrade, remove old udev.
    rule unless modified in which case move to new name.
  - debian/libxenomai1.postinst: Do not create symlink.
  - debian/libxenomai1.postrm: No symlink to remove.
  - Bump build-depend on debhelper to install udev rules into
    /lib/udev/rules.d, add Breaks on udev to get correct version.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/generated/html/api/group__select.html
4
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
5
5
<link href="tabs.css" rel="stylesheet" type="text/css">
6
6
</head><body>
7
 
<!-- Generated by Doxygen 1.5.5 -->
 
7
<!-- Generated by Doxygen 1.5.6 -->
8
8
<div class="navigation" id="top">
9
9
  <div class="tabs">
10
10
    <ul>
38
38
<div class="dynsection">
39
39
<center><table><tr><td><img src="group__select.png" border="0" alt="" usemap="#group____select_map">
40
40
<map name="group____select_map">
41
 
<area shape="rect" href="group__nucleus.html" title="Xenomai nucleus." alt="" coords="5,6,131,30"></map></td></tr></table></center>
 
41
<area shape="rect" href="group__nucleus.html" title="Xenomai nucleus." alt="" coords="5,5,131,32"></map></td></tr></table></center>
42
42
</div>
43
43
<hr><a name="_details"></a><h2>Detailed Description</h2>
44
44
File descriptors events multiplexing services.<p>
127
127
        <tr>
128
128
          <td></td>
129
129
          <td>)</td>
130
 
          <td></td><td></td><td width="100%"></td>
 
130
          <td></td><td></td><td></td>
131
131
        </tr>
132
132
      </table>
133
133
</div>
149
149
<dl compact><dt><b>Return values:</b></dt><dd>
150
150
  <table border="0" cellspacing="2" cellpadding="0">
151
151
    <tr><td valign="top"></td><td valign="top"><em>-EINVAL</em>&nbsp;</td><td>if <em>nfds</em> is negative; </td></tr>
152
 
    <tr><td valign="top"></td><td valign="top"><em>-ECHRNG</em>&nbsp;</td><td>if some of the descriptors passed in <em>in_fds</em> have not yet been registered with xnselect_bind(), <em>out_fds</em> contains the set of such descriptors; </td></tr>
 
152
    <tr><td valign="top"></td><td valign="top"><em>-ECHRNG</em>&nbsp;</td><td>if some of the descriptors passed in <em>in_fds</em> have not yet been registered with <a class="el" href="group__select.html#g8546a4a6f997a8c29451673d5b7f0e86" title="Bind a file descriptor (represented by its xnselect structure) to a selector block...">xnselect_bind()</a>, <em>out_fds</em> contains the set of such descriptors; </td></tr>
153
153
    <tr><td valign="top"></td><td valign="top"><em>-EINTR</em>&nbsp;</td><td>if <em>xnselect</em> was interrupted while waiting; </td></tr>
154
154
    <tr><td valign="top"></td><td valign="top"><em>0</em>&nbsp;</td><td>in case of timeout. </td></tr>
155
155
    <tr><td valign="top"></td><td valign="top"><em>the</em>&nbsp;</td><td>number of file descriptors having received an event. </td></tr>
205
205
        <tr>
206
206
          <td></td>
207
207
          <td>)</td>
208
 
          <td></td><td></td><td width="100%"></td>
 
208
          <td></td><td></td><td></td>
209
209
        </tr>
210
210
      </table>
211
211
</div>
224
224
    <tr><td valign="top"></td><td valign="top"><em>state</em>&nbsp;</td><td>current state of the file descriptor&gt;.</td></tr>
225
225
  </table>
226
226
</dl>
227
 
<em>select_block</em> must have been initialized with xnselect_init(), the <em>xnselector</em> structure must have been initialized with <a class="el" href="group__select.html#gf5576af13d5ffd6056311c2746a706a0" title="Initialize a selector structure.">xnselector_init()</a>, <em>binding</em> may be uninitialized.<p>
 
227
<em>select_block</em> must have been initialized with <a class="el" href="group__select.html#g80b33cc02e860dc6ffbd08e8da376e5b" title="Initialize a struct xnselect structure.">xnselect_init()</a>, the <em>xnselector</em> structure must have been initialized with <a class="el" href="group__select.html#gf5576af13d5ffd6056311c2746a706a0" title="Initialize a selector structure.">xnselector_init()</a>, <em>binding</em> may be uninitialized.<p>
228
228
This service must be called with nklock locked, irqs off. For this reason, the <em>binding</em> parameter must have been allocated by the caller outside the locking section.<p>
229
229
<dl compact><dt><b>Return values:</b></dt><dd>
230
230
  <table border="0" cellspacing="2" cellpadding="0">
233
233
  </table>
234
234
</dl>
235
235
 
236
 
<p>References <a class="el" href="pod_8c-source.html#l02377">xnpod_schedule()</a>.</p>
 
236
<p>References <a class="el" href="pod_8c-source.html#l02378">xnpod_schedule()</a>.</p>
 
237
 
 
238
<p>Referenced by <a class="el" href="drvlib_8c-source.html#l01048">rtdm_event_select_bind()</a>, and <a class="el" href="drvlib_8c-source.html#l01331">rtdm_sem_select_bind()</a>.</p>
237
239
 
238
240
</div>
239
241
</div><p>
247
249
          <td class="paramtype">struct xnselect *&nbsp;</td>
248
250
          <td class="paramname"> <em>select_block</em>          </td>
249
251
          <td>&nbsp;)&nbsp;</td>
250
 
          <td width="100%"></td>
 
252
          <td></td>
251
253
        </tr>
252
254
      </table>
253
255
</div>
275
277
          <td class="paramtype">struct xnselect *&nbsp;</td>
276
278
          <td class="paramname"> <em>select_block</em>          </td>
277
279
          <td>&nbsp;)&nbsp;</td>
278
 
          <td width="100%"></td>
 
280
          <td></td>
279
281
        </tr>
280
282
      </table>
281
283
</div>
284
286
<p>
285
287
Initialize a <em>struct</em> <em>xnselect</em> structure. 
286
288
<p>
287
 
This service must be called to initialize a <em>struct</em> <em>xnselect</em> structure before it is bound to a selector by the means of xnselect_bind().<p>
 
289
This service must be called to initialize a <em>struct</em> <em>xnselect</em> structure before it is bound to a selector by the means of <a class="el" href="group__select.html#g8546a4a6f997a8c29451673d5b7f0e86" title="Bind a file descriptor (represented by its xnselect structure) to a selector block...">xnselect_bind()</a>.<p>
288
290
<dl compact><dt><b>Parameters:</b></dt><dd>
289
291
  <table border="0" cellspacing="2" cellpadding="0">
290
292
    <tr><td valign="top"></td><td valign="top"><em>select_block</em>&nbsp;</td><td>pointer to the xnselect structure to be initialized </td></tr>
291
293
  </table>
292
294
</dl>
293
295
 
 
296
<p>Referenced by <a class="el" href="drvlib_8c-source.html#l00749">rtdm_event_init()</a>, and <a class="el" href="drvlib_8c-source.html#l01096">rtdm_sem_init()</a>.</p>
 
297
 
294
298
</div>
295
299
</div><p>
296
300
<a class="anchor" name="g9f4741ca8d6794f1b45478a24b1104de"></a><!-- doxytag: member="select.c::xnselector_destroy" ref="g9f4741ca8d6794f1b45478a24b1104de" args="(struct xnselector *selector)" -->
303
307
          <td class="paramtype">struct xnselector *&nbsp;</td>
304
308
          <td class="paramname"> <em>selector</em>          </td>
305
309
          <td>&nbsp;)&nbsp;</td>
306
 
          <td width="100%"></td>
 
310
          <td></td>
307
311
        </tr>
308
312
      </table>
309
313
</div>
319
323
  </table>
320
324
</dl>
321
325
 
322
 
<p>References <a class="el" href="pod_8c-source.html#l02377">xnpod_schedule()</a>, and <a class="el" href="select_8c-source.html#l00310">xnselect()</a>.</p>
 
326
<p>References <a class="el" href="pod_8c-source.html#l02378">xnpod_schedule()</a>, and <a class="el" href="select_8c-source.html#l00310">xnselect()</a>.</p>
323
327
 
324
328
</div>
325
329
</div><p>
333
337
          <td class="paramtype">struct xnselector *&nbsp;</td>
334
338
          <td class="paramname"> <em>selector</em>          </td>
335
339
          <td>&nbsp;)&nbsp;</td>
336
 
          <td width="100%"></td>
 
340
          <td></td>
337
341
        </tr>
338
342
      </table>
339
343
</div>
358
362
</div>
359
363
</div><p>
360
364
</div>
361
 
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Jun 8 18:08:50 2008 for Xenomai API by&nbsp;
 
365
<hr size="1"><address style="text-align: right;"><small>Generated on Thu May 28 16:22:10 2009 for Xenomai API by&nbsp;
362
366
<a href="http://www.doxygen.org/index.html">
363
 
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
 
367
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
364
368
</body>
365
369
</html>