diff options
| author | Guy Harris <guy@alum.mit.edu> | 2015-12-01 01:34:38 -0800 |
|---|---|---|
| committer | Guy Harris <guy@alum.mit.edu> | 2015-12-01 01:34:38 -0800 |
| commit | 9265bf76e91fb00c01c784804abbe0524e0b4d58 (patch) | |
| tree | f14908a0adf72e2bd3510b5cfdd48a4748b3389b /pcap_set_timeout.3pcap | |
| parent | 67508c825d939f28e2dad3e51a5e341be2de876e (diff) | |
| download | libpcap-9265bf76e91fb00c01c784804abbe0524e0b4d58.tar.gz | |
Add a warning about the behavior if no timeout is set.
Picked up from the OS X pcap_set_timeout() man page, but with a note
about immediate mode added (if immediate mode is set, the timeout is
irrelevant, as it has no effect - packets are delivered immediately).
Diffstat (limited to 'pcap_set_timeout.3pcap')
| -rw-r--r-- | pcap_set_timeout.3pcap | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/pcap_set_timeout.3pcap b/pcap_set_timeout.3pcap index b7282037..a89327f2 100644 --- a/pcap_set_timeout.3pcap +++ b/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) |