blob: d49f1ee0742ddeeb28d12c99ff6673ed8bcc95b3 [file] [log] [blame]
.. -*- coding: utf-8; mode: rst -*-
.. _cec-func-poll:
cec poll()
cec-poll - Wait for some event on a file descriptor
.. code-block:: c
#include <sys/poll.h>
.. c:function:: int poll( struct pollfd *ufds, unsigned int nfds, int timeout )
:name: cec-poll
List of FD events to be watched
Number of FD events at the \*ufds array
Timeout to wait for events
With the :c:func:`poll() <cec-poll>` function applications can wait for CEC
On success :c:func:`poll() <cec-poll>` returns the number of file descriptors
that have been selected (that is, file descriptors for which the
``revents`` field of the respective struct :c:type:`pollfd`
is non-zero). CEC devices set the ``POLLIN`` and ``POLLRDNORM`` flags in
the ``revents`` field if there are messages in the receive queue. If the
transmit queue has room for new messages, the ``POLLOUT`` and
``POLLWRNORM`` flags are set. If there are events in the event queue,
then the ``POLLPRI`` flag is set. When the function times out it returns
a value of zero, on failure it returns -1 and the ``errno`` variable is
set appropriately.
For more details see the :c:func:`poll() <cec-poll>` manual page.
Return Value
On success, :c:func:`poll() <cec-poll>` returns the number structures which have
non-zero ``revents`` fields, or zero if the call timed out. On error -1
is returned, and the ``errno`` variable is set appropriately:
One or more of the ``ufds`` members specify an invalid file
``ufds`` references an inaccessible memory area.
The call was interrupted by a signal.
The ``nfds`` argument is greater than ``OPEN_MAX``.