Documentation/linux_tv/media/dvb/FE_GET_EVENT.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _FE_GET_EVENT:
   4
   5 ************
   6 FE_GET_EVENT
   7 ************
   8
   9 Description
  10 -----------
  11
  12 This ioctl call returns a frontend event if available. If an event is
  13 not available, the behavior depends on whether the device is in blocking
  14 or non-blocking mode. In the latter case, the call fails immediately
  15 with errno set to ``EWOULDBLOCK``. In the former case, the call blocks until
  16 an event becomes available.
  17
  18 Synopsis
  19 --------
  20
  21 .. c:function:: int  ioctl(int fd, int request = QPSK_GET_EVENT, struct dvb_frontend_event *ev)
  22
  23 Arguments
  24 ----------
  25
  26
  27
  28 .. flat-table::
  29     :header-rows:  0
  30     :stub-columns: 0
  31
  32
  33     -  .. row 1
  34
  35        -  int fd
  36
  37        -  File descriptor returned by a previous call to open().
  38
  39     -  .. row 2
  40
  41        -  int request
  42
  43        -  Equals :ref:`FE_GET_EVENT` for this command.
  44
  45     -  .. row 3
  46
  47        -  struct dvb_frontend_event *ev
  48
  49        -  Points to the location where the event,
  50
  51     -  .. row 4
  52
  53        -
  54        -  if any, is to be stored.
  55
  56
  57 Return Value
  58 ------------
  59
  60 On success 0 is returned, on error -1 and the ``errno`` variable is set
  61 appropriately. The generic error codes are described at the
  62 :ref:`Generic Error Codes <gen-errors>` chapter.
  63
  64
  65
  66 .. flat-table::
  67     :header-rows:  0
  68     :stub-columns: 0
  69
  70
  71     -  .. row 1
  72
  73        -  ``EWOULDBLOCK``
  74
  75        -  There is no event pending, and the device is in non-blocking mode.
  76
  77     -  .. row 2
  78
  79        -  ``EOVERFLOW``
  80
  81        -  Overflow in event queue - one or more events were lost.