aboutsummaryrefslogtreecommitdiff
path: root/contrib/libpcap/pcap_set_timeout.3pcap
diff options
context:
space:
mode:
authorHans Petter Selasky <hselasky@FreeBSD.org>2018-05-28 08:12:18 +0000
committerHans Petter Selasky <hselasky@FreeBSD.org>2018-05-28 08:12:18 +0000
commitb00ab7548b418624b6719ab8a2e8aaeade767a70 (patch)
treea300b8fb3f3e9cbbd48c47fde148dcb40453e7de /contrib/libpcap/pcap_set_timeout.3pcap
parent7e3d9013f2ff9291970339df66a18ad9343ed433 (diff)
parentd109bf9e4b609b5a0626b433e56db4a47dc530bb (diff)
MFV r333789: libpcap 1.9.0 (pre-release)
MFC after: 1 month Sponsored by: Mellanox Technologies
Notes
Notes: svn path=/head/; revision=334277
Diffstat (limited to 'contrib/libpcap/pcap_set_timeout.3pcap')
-rw-r--r--contrib/libpcap/pcap_set_timeout.3pcap19
1 files changed, 11 insertions, 8 deletions
diff --git a/contrib/libpcap/pcap_set_timeout.3pcap b/contrib/libpcap/pcap_set_timeout.3pcap
index a89327f2ebd2..8cb8cb6487d8 100644
--- a/contrib/libpcap/pcap_set_timeout.3pcap
+++ b/contrib/libpcap/pcap_set_timeout.3pcap
@@ -17,10 +17,10 @@
.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
.\"
-.TH PCAP_SET_TIMEOUT 3PCAP "1 December 2015"
+.TH PCAP_SET_TIMEOUT 3PCAP "20 January 2017"
.SH NAME
-pcap_set_timeout \- set the read timeout for a not-yet-activated
-capture handle
+pcap_set_timeout \- set the packet buffer timeout for a
+not-yet-activated capture handle
.SH SYNOPSIS
.nf
.ft B
@@ -32,12 +32,15 @@ int pcap_set_timeout(pcap_t *p, int to_ms);
.fi
.SH DESCRIPTION
.B pcap_set_timeout()
-sets the read timeout that will be used on a capture handle when
-the handle is activated to
+sets the packet buffer timeout that will be used on a capture handle
+when the handle is activated to
.IR to_ms ,
-which is in units of milliseconds.
+which is in units of milliseconds. (See
+.BR pcap (3PCAP)
+for an explanation of the packet buffer timeout.)
.LP
-The behavior, if the timeout isn't specified, is undefined. We
+The behavior, if the timeout isn't specified, is undefined, as is the
+behavior if the timeout is set to zero or to a negative value. We
recommend always setting the timeout to a non-zero value unless
immediate mode is set, in which case the timeout has no effect.
.SH RETURN VALUE
@@ -47,4 +50,4 @@ returns 0 on success or
if called on a capture handle that has been activated.
.SH SEE ALSO
pcap(3PCAP), pcap_create(3PCAP), pcap_activate(3PCAP),
-pcap_set_immediate_mode(3PCAP)
+\%pcap_set_immediate_mode(3PCAP)