Commit | Line | Data |
---|---|---|
5377d91f MH |
1 | .. -*- coding: utf-8; mode: rst -*- |
2 | ||
3 | .. _FE_GET_EVENT: | |
4 | ||
5 | ************ | |
6 | FE_GET_EVENT | |
7 | ************ | |
8 | ||
e3a54ab8 MCC |
9 | Description |
10 | ----------- | |
5377d91f MH |
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 | |
cdb4af0f | 15 | with errno set to ``EWOULDBLOCK``. In the former case, the call blocks until |
5377d91f MH |
16 | an event becomes available. |
17 | ||
e3a54ab8 MCC |
18 | Synopsis |
19 | -------- | |
5377d91f | 20 | |
e3a54ab8 | 21 | .. c:function:: int ioctl(int fd, int request = QPSK_GET_EVENT, struct dvb_frontend_event *ev) |
5377d91f | 22 | |
e3a54ab8 MCC |
23 | Arguments |
24 | ---------- | |
5377d91f MH |
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 | ||
7347081e | 43 | - Equals :ref:`FE_GET_EVENT` for this command. |
5377d91f MH |
44 | |
45 | - .. row 3 | |
46 | ||
5d2b3f12 | 47 | - struct dvb_frontend_event \*ev |
5377d91f MH |
48 | |
49 | - Points to the location where the event, | |
50 | ||
51 | - .. row 4 | |
52 | ||
0579e6e3 | 53 | - |
5377d91f MH |
54 | - if any, is to be stored. |
55 | ||
56 | ||
e3a54ab8 MCC |
57 | Return Value |
58 | ------------ | |
5377d91f MH |
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 | ||
cdb4af0f | 73 | - ``EWOULDBLOCK`` |
5377d91f MH |
74 | |
75 | - There is no event pending, and the device is in non-blocking mode. | |
76 | ||
77 | - .. row 2 | |
78 | ||
cdb4af0f | 79 | - ``EOVERFLOW`` |
5377d91f MH |
80 | |
81 | - Overflow in event queue - one or more events were lost. |