File: func-ref-comedi-poll.html

package info (click to toggle)
comedilib 0.11.0-1
links: PTS
area: main
in suites: buster
size: 8,388 kB
sloc: xml: 19,779; ansic: 14,719; sh: 4,583; cpp: 2,195; ruby: 1,658; perl: 700; makefile: 604; yacc: 439; lex: 86; python: 17
file content (17 lines) | stat: -rw-r--r-- 3,195 bytes
parent folder | download | duplicates (3)
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>comedi_poll</title><link rel="stylesheet" type="text/css" href="comedilib.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Comedi"><link rel="up" href="functionreference.html#idm3568" title="5.4.2. Asynchronous commands"><link rel="prev" href="func-ref-comedi-mark-buffer-written.html" title="comedi_mark_buffer_written"><link rel="next" href="func-ref-comedi-set-buffer-size.html" title="comedi_set_buffer_size"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">comedi_poll</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="func-ref-comedi-mark-buffer-written.html">Prev</a> </td><th width="60%" align="center">5.4.2. Asynchronous commands</th><td width="20%" align="right"> <a accesskey="n" href="func-ref-comedi-set-buffer-size.html">Next</a></td></tr></table><hr></div><div class="refentry"><a name="func-ref-comedi-poll"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>comedi_poll — force updating of streaming buffer</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="funcsynopsis"><pre class="funcsynopsisinfo">#include &lt;comedilib.h&gt;</pre><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">int <b class="fsfunc">comedi_poll</b>(</code></td><td>comedi_t * <var class="pdparam">device</var>, </td></tr><tr><td> </td><td>unsigned int <var class="pdparam">subdevice</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a name="idm4208"></a><h2>
      Description
    </h2><p>
The function <code class="function">comedi_poll</code> is used on a subdevice that has a
Comedi command in progress in order to update the streaming buffer.
If supported by the driver, all available samples are copied to
the streaming buffer.  These samples may be pending in DMA buffers
or device FIFOs.
Only a few Comedi drivers support this operation.
    </p></div><div class="refsect1"><a name="idm4212"></a><h2>
      Return value
    </h2><p>
On success, <code class="function">comedi_poll</code> returns the number of additional
bytes available.
On failure, <code class="literal">-1</code> is returned.
</p><p>
    </p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="func-ref-comedi-mark-buffer-written.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="functionreference.html#idm3568">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="func-ref-comedi-set-buffer-size.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">comedi_mark_buffer_written </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> comedi_set_buffer_size</td></tr></table></div></body></html>