Imported Upstream version 1.9.1upstream/1.9.1upstream

Change-Id: I8ccc371679c730299ebe8068ed5af0ae033c4f7d
Signed-off-by: Cheoleun Moon <chleun.moon@samsung.com>

1 files changed, 15 insertions, 7 deletions

diff --git a/pcap_set_timeout.3pcap b/pcap_set_timeout.3pcap
index b728203..e67b813 100644
--- a/pcap_set_timeout.3pcap
+++ b/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 "16 April 2014"
+.TH PCAP_SET_TIMEOUT 3PCAP "6 December 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,14 +32,22 @@ 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, 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
 .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_create(3PCAP), pcap_activate(3PCAP),
+\%pcap_set_immediate_mode(3PCAP)