1PCAP_GET_SELECTABLE_FD(3PCAP) PCAP_GET_SELECTABLE_FD(3PCAP)
2
6 pcap_get_selectable_fd - get a file descriptor on which a select() can
7 be done for a live capture
8
10 #include <pcap/pcap.h>
11 int pcap_get_selectable_fd(pcap_t *p);
13
15 pcap_get_selectable_fd() returns, on UNIX, a file descriptor number for
16 a file descriptor on which one can do a select(2), poll(2),
17 epoll_wait(2), kevent(2), or other such call to wait for it to be pos‐
18 sible to read packets without blocking, if such a descriptor exists, or
19 -1, if no such descriptor exists.
20 Some network devices opened with pcap_create(3PCAP) and pcap_acti‐
22 vate(3PCAP), or with pcap_open_live(3PCAP), do not support those calls
23 (for example, regular network devices on FreeBSD 4.3 and 4.4, and
24 Endace DAG devices), so -1 is returned for those devices. In that
25 case, those calls must be given a timeout less than or equal to the
26 timeout returned by pcap_get_required_select_timeout(3PCAP) for the
27 device for which pcap_get_selectable_fd() returned -1, the device must
28 be put in non-blocking mode with a call to pcap_setnonblock(3PCAP), and
29 an attempt must always be made to read packets from the device when the
30 call returns. If pcap_get_required_select_timeout() returns NULL, it
31 is not possible to wait for packets to arrive on the device in an event
32 loop.
33 Note that a device on which a read can be done without blocking may, on
35 some platforms, not have any packets to read if the packet buffer time‐
36 out has expired. A call to pcap_dispatch(3PCAP) or pcap_next_ex(3PCAP)
37 will return 0 in this case, but will not block.
38 Note that in:
40 FreeBSD prior to FreeBSD 4.6;
42 NetBSD prior to NetBSD 3.0;
44 OpenBSD prior to OpenBSD 2.4;
46 Mac OS X prior to Mac OS X 10.7;
48 select(), poll(), and kevent() do not work correctly on BPF devices;
50 pcap_get_selectable_fd() will return a file descriptor on most of those
51 versions (the exceptions being FreeBSD 4.3 and 4.4), but a simple
52 select(), poll(), or kevent() call will not indicate that the descrip‐
53 tor is readable until a full buffer's worth of packets is received,
54 even if the packet timeout expires before then. To work around this,
55 code that uses those calls to wait for packets to arrive must put the
56 pcap_t in non-blocking mode, and must arrange that the call have a
57 timeout less than or equal to the packet buffer timeout, and must try
58 to read packets after that timeout expires, regardless of whether the
59 call indicated that the file descriptor for the pcap_t is ready to be
60 read or not. (That workaround will not work in FreeBSD 4.3 and later;
61 however, in FreeBSD 4.6 and later, those calls work correctly on BPF
62 devices, so the workaround isn't necessary, although it does no harm.)
63 Note also that poll() and kevent() doesn't work on character special
65 files, including BPF devices, in Mac OS X 10.4 and 10.5, so, while
66 select() can be used on the descriptor returned by
67 pcap_get_selectable_fd(), poll() and kevent() cannot be used on it
68 those versions of Mac OS X. poll(), but not kevent(), works on that
69 descriptor in Mac OS X releases prior to 10.4; poll() and kevent() work
70 on that descriptor in Mac OS X 10.6 and later.
71 pcap_get_selectable_fd() is not available on Windows.
73
75 A selectable file descriptor is returned if one exists; otherwise, -1
76 is returned.
77
79 pcap(3PCAP), kqueue(2)
80 29 January 2020 PCAP_GET_SELECTABLE_FD(3PCAP)