Documentation/media/uapi/cec/cec-func-poll.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _cec-func-poll:
   4
   5 **********
   6 cec poll()
   7 **********
   8
   9 Name
  10 ====
  11
  12 cec-poll - Wait for some event on a file descriptor
  13
  14
  15 Synopsis
  16 ========
  17
  18 .. code-block:: c
  19
  20     #include <sys/poll.h>
  21
  22
  23 .. c:function:: int poll( struct pollfd *ufds, unsigned int nfds, int timeout )
  24    :name: cec-poll
  25
  26 Arguments
  27 =========
  28
  29 ``ufds``
  30    List of FD events to be watched
  31
  32 ``nfds``
  33    Number of FD events at the \*ufds array
  34
  35 ``timeout``
  36    Timeout to wait for events
  37
  38
  39 Description
  40 ===========
  41
  42 With the :c:func:`poll() <cec-poll>` function applications can wait for CEC
  43 events.
  44
  45 On success :c:func:`poll() <cec-poll>` returns the number of file descriptors
  46 that have been selected (that is, file descriptors for which the
  47 ``revents`` field of the respective struct :c:type:`pollfd`
  48 is non-zero). CEC devices set the ``POLLIN`` and ``POLLRDNORM`` flags in
  49 the ``revents`` field if there are messages in the receive queue. If the
  50 transmit queue has room for new messages, the ``POLLOUT`` and
  51 ``POLLWRNORM`` flags are set. If there are events in the event queue,
  52 then the ``POLLPRI`` flag is set. When the function times out it returns
  53 a value of zero, on failure it returns -1 and the ``errno`` variable is
  54 set appropriately.
  55
  56 For more details see the :c:func:`poll() <cec-poll>` manual page.
  57
  58
  59 Return Value
  60 ============
  61
  62 On success, :c:func:`poll() <cec-poll>` returns the number structures which have
  63 non-zero ``revents`` fields, or zero if the call timed out. On error -1
  64 is returned, and the ``errno`` variable is set appropriately:
  65
  66 ``EBADF``
  67     One or more of the ``ufds`` members specify an invalid file
  68     descriptor.
  69
  70 ``EFAULT``
  71     ``ufds`` references an inaccessible memory area.
  72
  73 ``EINTR``
  74     The call was interrupted by a signal.
  75
  76 ``EINVAL``
  77     The ``nfds`` value exceeds the ``RLIMIT_NOFILE`` value. Use
  78     ``getrlimit()`` to obtain this value.