summaryrefslogtreecommitdiff
path: root/pcap_get_selectable_fd.3pcap
diff options
context:
space:
mode:
authorGuy Harris <guy@alum.mit.edu>2017-01-20 01:44:06 -0800
committerGuy Harris <guy@alum.mit.edu>2017-01-20 01:44:06 -0800
commitb4d719c1ea2a843a762a4831999a461b19a9f1e0 (patch)
treef579622f28716053853cd393672d749115eb4c45 /pcap_get_selectable_fd.3pcap
parentd61d4ede72cce3b850105b7ce0da9e4f120d45c1 (diff)
downloadlibpcap-b4d719c1ea2a843a762a4831999a461b19a9f1e0.tar.gz
Call the timeout the "packet buffer timeout" rather than the "read timeout".
That should make it clearer that the timeout does *not* guarantee that a call that reads packets will return within N milliseconds even if no packets arrive. In the pcap_open_live() and pcap_set_timeout() calls, point to the detailed description of the packet buffer timeout in pcap(3PCAP).
Diffstat (limited to 'pcap_get_selectable_fd.3pcap')
-rw-r--r--pcap_get_selectable_fd.3pcap10
1 files changed, 5 insertions, 5 deletions
diff --git a/pcap_get_selectable_fd.3pcap b/pcap_get_selectable_fd.3pcap
index 86b0c268..aa457a23 100644
--- a/pcap_get_selectable_fd.3pcap
+++ b/pcap_get_selectable_fd.3pcap
@@ -17,7 +17,7 @@
.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
.\"
-.TH PCAP_GET_SELECTABLE_FD 3PCAP "18 October 2014"
+.TH PCAP_GET_SELECTABLE_FD 3PCAP "20 January 2017"
.SH NAME
pcap_get_selectable_fd \- get a file descriptor on which a select() can
be done for a live capture
@@ -55,8 +55,8 @@ or
DAG devices), so \-1 is returned for those devices.
.PP
Note that a descriptor on which a read can be done without blocking may,
-on some platforms, not have any packets to read if the read timeout has
-expired. A call to
+on some platforms, not have any packets to read if the packet buffer
+timeout has expired. A call to
.B pcap_dispatch()
will return 0 in this case, but will not block.
.PP
@@ -81,7 +81,7 @@ being FreeBSD 4.3 and 4.4), but a simple
or
.B poll()
will not indicate that the descriptor is readable until a full buffer's
-worth of packets is received, even if the read timeout expires before
+worth of packets is received, even if the packet timeout expires before
then. To work around this, an application that uses
.B select()
or
@@ -92,7 +92,7 @@ in non-blocking mode, and must arrange that the
.B select()
or
.B poll()
-have a timeout less than or equal to the read timeout,
+have a timeout less than or equal to the packet buffer timeout,
and must try to read packets after that timeout expires, regardless of
whether
.B select()