summaryrefslogtreecommitdiff
path: root/pcap_breakloop.3pcap
diff options
context:
space:
mode:
authorDenis Ovsienko <denis@ovsienko.info>2018-07-25 16:32:12 +0000
committerDenis Ovsienko <denis@ovsienko.info>2018-07-25 16:32:49 +0000
commit6e15abcfff9504c9c26c249db56179c4c26c1b16 (patch)
tree4d31617d075291e961a4f26ba01797698421e5e9 /pcap_breakloop.3pcap
parentf19ee14e460e63143c2ba4e4442b7226c769f79c (diff)
downloadlibpcap-6e15abcfff9504c9c26c249db56179c4c26c1b16.tar.gz
Spell PCAP_ERROR and PCAP_ERROR_BREAK in the man pages.
[skip ci]
Diffstat (limited to 'pcap_breakloop.3pcap')
-rw-r--r--pcap_breakloop.3pcap15
1 files changed, 10 insertions, 5 deletions
diff --git a/pcap_breakloop.3pcap b/pcap_breakloop.3pcap
index f3cb52e2..cc000d2e 100644
--- a/pcap_breakloop.3pcap
+++ b/pcap_breakloop.3pcap
@@ -17,7 +17,7 @@
.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
.\"
-.TH PCAP_BREAKLOOP 3PCAP "8 November 2017"
+.TH PCAP_BREAKLOOP 3PCAP "25 July 2018"
.SH NAME
pcap_breakloop \- force a pcap_dispatch() or pcap_loop() call to return
.SH SYNOPSIS
@@ -37,8 +37,9 @@ sets a flag that will force
or
.B pcap_loop(3PCAP)
to return rather than looping; they will return the number of packets
-that have been processed so far, or \-2 if no packets have been
-processed so far.
+that have been processed so far, or
+.B PCAP_ERROR_BREAK
+if no packets have been processed so far.
.PP
This routine is safe to use inside a signal handler on UNIX or a console
control handler on Windows, as it merely sets a flag that is checked
@@ -99,12 +100,16 @@ or
.B pcap_loop()
after it is called; at most one more packet might be processed.
.PP
-If \-2 is returned from
+If
+.B PCAP_ERROR_BREAK
+is returned from
.B pcap_dispatch()
or
.BR pcap_loop() ,
the flag is cleared, so a subsequent call will resume reading packets.
If a positive number is returned, the flag is not cleared, so a
-subsequent call will return \-2 and clear the flag.
+subsequent call will return
+.B PCAP_ERROR_BREAK
+and clear the flag.
.SH SEE ALSO
pcap(3PCAP)