]> The Tcpdump Group git mirrors - libpcap/commitdiff
Move the description of "pcap_[sg]etnonblock()" immediately after the
authorguy <guy>
Sun, 9 Dec 2001 08:58:28 +0000 (08:58 +0000)
committerguy <guy>
Sun, 9 Dec 2001 08:58:28 +0000 (08:58 +0000)
description of the routines to open captures, so that non-blocking mode
is described before "pcap_dispatch()" is described.

pcap.3

diff --git a/pcap.3 b/pcap.3
index 01aa714cc9fbb839e3f1df78797c1765bdb05119..e48547dc701be8f685cf06e12623cfc1037d9c7f 100644 (file)
--- a/pcap.3
+++ b/pcap.3
@@ -1,4 +1,4 @@
-.\" @(#) $Header: /tcpdump/master/libpcap/Attic/pcap.3,v 1.28 2001-12-09 05:10:02 guy Exp $
+.\" @(#) $Header: /tcpdump/master/libpcap/Attic/pcap.3,v 1.29 2001-12-09 08:58:28 guy Exp $
 .\"
 .\" Copyright (c) 1994, 1996, 1997
 .\"    The Regents of the University of California.  All rights reserved.
@@ -43,6 +43,11 @@ pcap_dumper_t *pcap_dump_open(pcap_t *p, char *fname)
 .ft
 .LP
 .ft B
+int pcap_setnonblock(pcap_t *, int nonblock, char *errbuf);
+int pcap_getnonblock(pcap_t *p, char *errbuf);
+.ft
+.LP
+.ft B
 int pcap_findalldevs(pcap_if_t **alldevsp, char *errbuf)
 void pcap_freealldevs(pcap_if_t *)
 char *pcap_lookupdev(char *errbuf)
@@ -76,11 +81,6 @@ u_char *pcap_next(pcap_t *p, struct pcap_pkthdr *h)
 .ft
 .LP
 .ft B
-int pcap_setnonblock(pcap_t *, int nonblock, char *errbuf);
-int pcap_getnonblock(pcap_t *p, char *errbuf);
-.ft
-.LP
-.ft B
 int pcap_datalink(pcap_t *p)
 int pcap_snapshot(pcap_t *p)
 int pcap_is_swapped(pcap_t *p)
@@ -109,11 +109,13 @@ through this mechanism.
 NOTE:
 .I errbuf
 in
-.B pcap_open_live(),
-.B pcap_open_dead(),
-.B pcap_open_offline(),
-.B pcap_findalldevs(),
-.B pcap_lookupdev(),
+.BR pcap_open_live() ,
+.BR pcap_open_dead() ,
+.BR pcap_open_offline() ,
+.BR pcap_setnonblock() ,
+.BR pcap_getnonblock() ,
+.BR pcap_findalldevs() ,
+.BR pcap_lookupdev() ,
 and
 .B pcap_lookupnet()
 is assumed to be able to hold at least
@@ -206,6 +208,34 @@ is returned,
 .B pcap_geterr()
 can be used to get the error text.
 .PP
+.B pcap_setnonblock()
+puts a capture descriptor, opened with
+.BR pcap_open_live() ,
+into ``non-blocking'' mode, or takes it out of ``non-blocking'' mode,
+depending on whether the
+.I nonblock
+argument is non-zero or zero.  It has no effect on ``savefiles''.
+If there is an error, \-1 is returned and
+.I errbuf
+is filled in with an appropriate error message.
+In
+``non-blocking'' mode, an attempt to read from the capture descriptor
+with
+.B pcap_dispatch()
+will, if no packets are currently available to be read, return 0
+immediately rather than blocking waiting for packets to arrive.
+.B pcap_loop()
+and
+.B pcap_next()
+will not work in ``non-blocking'' mode.
+.PP
+.B pcap_getnonblock()
+returns the current ``non-blocking'' state of the capture descriptor; it
+always returns 0 on ``savefiles''.
+If there is an error, \-1 is returned and
+.I errbuf
+is filled in with an appropriate error message.
+.PP
 .B pcap_findalldevs()
 constructs a list of network devices that can be opened with
 .BR pcap_open_live() .
@@ -486,34 +516,6 @@ when that BPF program is no longer needed, for example after it
 has been made the filter program for a pcap structure by a call to
 .BR pcap_setfilter() .
 .PP
-.B pcap_setnonblock()
-puts a capture descriptor, opened with
-.BR pcap_open_live() ,
-into ``non-blocking'' mode, or takes it out of ``non-blocking'' mode,
-depending on whether the
-.I nonblock
-argument is non-zero or zero.  It has no effect on ``savefiles''.
-If there is an error, \-1 is returned and
-.I errbuf
-is filled in with an appropriate error message.
-In
-``non-blocking'' mode, an attempt to read from the capture descriptor
-with
-.B pcap_dispatch()
-will, if no packets are currently available to be read, return 0
-immediately rather than blocking waiting for packets to arrive.
-.B pcap_loop()
-and
-.B pcap_next()
-will not work in ``non-blocking'' mode.
-.PP
-.B pcap_getnonblock()
-returns the current ``non-blocking'' state of the capture descriptor; it
-always returns 0 on ``savefiles''.
-If there is an error, \-1 is returned and
-.I errbuf
-is filled in with an appropriate error message.
-.PP
 .B pcap_datalink()
 returns the link layer type; link layer types it can return include:
 .PP