aboutsummaryrefslogtreecommitdiff
path: root/contrib/libpcap/pcap_set_timeout.3pcap
diff options
context:
space:
mode:
authorXin LI <delphij@FreeBSD.org>2017-02-13 08:23:39 +0000
committerXin LI <delphij@FreeBSD.org>2017-02-13 08:23:39 +0000
commitada6f083b93b4adce9c3b3ba00112528244a3b86 (patch)
treecb89d2b7657c6b206bb28e5a9ab17ef556d64986 /contrib/libpcap/pcap_set_timeout.3pcap
parent5dbc2ac93dbe46c66b0159f9cbf67146ae43656d (diff)
parentc8c6d70e300aa9261c4766502c179fc4cd2b22a0 (diff)
MFV r313676: libpcap 1.8.1
MFC after: 1 month
Notes
Notes: svn path=/head/; revision=313695
Diffstat (limited to 'contrib/libpcap/pcap_set_timeout.3pcap')
-rw-r--r--contrib/libpcap/pcap_set_timeout.3pcap9
1 files changed, 7 insertions, 2 deletions
diff --git a/contrib/libpcap/pcap_set_timeout.3pcap b/contrib/libpcap/pcap_set_timeout.3pcap
index b7282037b3e7..a89327f2ebd2 100644
--- a/contrib/libpcap/pcap_set_timeout.3pcap
+++ b/contrib/libpcap/pcap_set_timeout.3pcap
@@ -17,7 +17,7 @@
.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
.\"
-.TH PCAP_SET_TIMEOUT 3PCAP "16 April 2014"
+.TH PCAP_SET_TIMEOUT 3PCAP "1 December 2015"
.SH NAME
pcap_set_timeout \- set the read timeout for a not-yet-activated
capture handle
@@ -36,10 +36,15 @@ sets the read timeout that will be used on a capture handle when
the handle is activated to
.IR to_ms ,
which is in units of milliseconds.
+.LP
+The behavior, if the timeout isn't specified, is undefined. 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
.B pcap_set_timeout()
returns 0 on success or
.B PCAP_ERROR_ACTIVATED
if called on a capture handle that has been activated.
.SH SEE ALSO
-pcap(3PCAP), pcap_create(3PCAP), pcap_activate(3PCAP)
+pcap(3PCAP), pcap_create(3PCAP), pcap_activate(3PCAP),
+pcap_set_immediate_mode(3PCAP)