1PCAP_GET_REQUIRED_SELECT_TIMEOUT(3PCAP)PCAP_GET_REQUIRED_SELECT_TIMEOUT(3PCAP)
2
6 pcap_get_required_select_timeout - get a timeout to be used when doing
7 select() for a live capture
8
10 #include <pcap/pcap.h>
11 const struct timeval *pcap_get_required_select_timeout(pcap_t *p);
13
15 pcap_get_required_select_timeout() returns, on UNIX, a pointer to a
16 struct timeval containing a value that must be used as the minimum
17 timeout in select(2), poll(2), epoll_wait(2), and kevent(2) calls, or
18 NULL if there is no such timeout. If a non-NULL value is returned, it
19 must be used regardless of whether pcap_get_selectable_fd(3PCAP)
20 returns -1 for any descriptor on which those calls are being done.
21 pcap_get_required_select_timeout() should be called for all pcap_ts
22 before a call to select(), poll(), epoll_wait(), or kevent(), and any
23 timeouts used for those calls should be updated as appropriate given
24 the new value of the timeout.
25 For kevent(), one EVFILT_TIMER filter per selectable descriptor can be
27 used, rather than using the timeout argument to kevent(); if the
28 EVFILT_TIMER event for a particular selectable descriptor signals an
29 event, pcap_dispatch(3PCAP) should be called for the corresponding
30 pcap_t.
31 On Linux systems with timerfd_create(2), one timer object created by
33 timerfd_create() per selectable descriptor can be used, rather than
34 using the timeout argument to epoll_wait(); if the timer object for a
35 particular selectable descriptor signals an event, pcap_dispatch(3PCAP)
36 should be called for the corresponding pcap_t.
37 Otherwise, a timeout value no larger than the smallest of all timeouts
39 returned by pcap_get_required_select_timeout() for devices from which
40 packets will be captured and any other timeouts to be used in the call
41 should be used as the timeout for the call, and, when the call returns,
42 pcap_dispatch(3PCAP) should be called for all pcap_ts for which a non-
43 NULL timeout was returned, regardless of whether it's indicated as hav‐
44 ing anything to read from it or not.
45 All devices with a non-NULL timeout must be put in non-blocking mode
47 with pcap_setnonblock(3PCAP).
48 Note that a device on which a read can be done without blocking may, on
50 some platforms, not have any packets to read if the packet buffer time‐
51 out has expired. A call to pcap_dispatch() or pcap_next_ex(3PCAP) will
52 return 0 in this case, but will not block.
53 pcap_get_required_select_timeout() is not available on Windows.
55
57 A pointer to a struct timeval is returned if the timeout is required;
58 otherwise NULL is returned.
59
61 This function became available in libpcap release 1.9.0. In previous
62 releases, select(), poll(), epoll_wait(), and kevent() cannot be used
63 on any capture source for which pcap_get_selectable_fd() returns -1.
64 In libpcap release 1.10.0 and later, the timeout value can change from
66 call to call, so pcap_get_required_select_timeout() must be called
67 before each call to select(), poll(), epoll_wait(), or kevent(), and
68 the new value must be used to calculate timeouts for the call. Code
69 that does that will also work with libpcap 1.9.x releases, so code
70 using pcap_get_required_select_timeout() should be changed to call it
71 for each call to select(), poll(), epoll_wait(), or kevent() even if
72 the code must also work with libpcap 1.9.x.
73
75 This function became available in libpcap release 1.9.0. In previous
76 releases, select(), poll(), epoll_wait(), and kevent() could not be
77 used for devices that don't provide a selectable file descriptor.
78
80 pcap(3PCAP), pcap_get_selectable_fd(3PCAP), select(2), poll(2),
81 epoll_wait(2), kqueue(2)
82 29 JanuaPrCyAP2_0G2E0T_REQUIRED_SELECT_TIMEOUT(3PCAP)