Documentation/linux_tv/media/dvb/dmx-get-event.rst

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