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