contrib/libpcap/pcap_setnonblock.3pcap

   1 .\" Copyright (c) 1994, 1996, 1997
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that: (1) source code distributions
   6 .\" retain the above copyright notice and this paragraph in its entirety, (2)
   7 .\" distributions including binary code include the above copyright notice and
   8 .\" this paragraph in its entirety in the documentation or other materials
   9 .\" provided with the distribution, and (3) all advertising materials mentioning
  10 .\" features or use of this software display the following acknowledgement:
  11 .\" ``This product includes software developed by the University of California,
  12 .\" Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
  13 .\" the University nor the names of its contributors may be used to endorse
  14 .\" or promote products derived from this software without specific prior
  15 .\" written permission.
  16 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
  17 .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
  18 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  19 .\"
  20 .TH PCAP_SETNONBLOCK 3PCAP "25 July 2018"
  21 .SH NAME
  22 pcap_setnonblock, pcap_getnonblock \- set or get the state of
  23 non-blocking mode on a capture device
  24 .SH SYNOPSIS
  25 .nf
  26 .ft B
  27 #include <pcap/pcap.h>
  28 .ft
  29 .LP
  30 .nf
  31 .ft B
  32 char errbuf[PCAP_ERRBUF_SIZE];
  33 .ft
  34 .LP
  35 .ft B
  36 int pcap_setnonblock(pcap_t *p, int nonblock, char *errbuf);
  37 int pcap_getnonblock(pcap_t *p, char *errbuf);
  38 .ft
  39 .fi
  40 .SH DESCRIPTION
  41 .BR pcap_setnonblock ()
  42 puts a capture handle into ``non-blocking'' mode, or takes it out
  43 of ``non-blocking'' mode, depending on whether the
  44 .I nonblock
  45 argument is non-zero or zero.  It has no effect on ``savefiles''.
  46 If there is an error,
  47 .B PCAP_ERROR
  48 is returned and
  49 .I errbuf
  50 is filled in with an appropriate error message; otherwise,
  51 .B 0
  52 is returned.
  53 .PP
  54 In
  55 ``non-blocking'' mode, an attempt to read from the capture descriptor
  56 with
  57 .BR pcap_dispatch (3PCAP)
  58 and
  59 .BR pcap_next_ex (3PCAP)
  60 will, if no packets are currently available to be read, return
  61 .B 0
  62 immediately rather than blocking waiting for packets to arrive.
  63 .PP
  64 .BR pcap_loop (3PCAP)
  65 will loop forever, consuming CPU time when no packets are currently
  66 available;
  67 .BR pacp_dispatch ()
  68 should be used instead.
  69 .BR pcap_next (3PCAP)
  70 will return
  71 .B NULL
  72 if there are no packets currently available to read;
  73 this is indistinguishable from an error, so
  74 .BR pcap_next_ex ()
  75 should be used instead.
  76 .PP
  77 When first activated with
  78 .BR pcap_activate (3PCAP)
  79 or opened with
  80 .BR pcap_open_live (3PCAP) ,
  81 a capture handle is not in ``non-blocking mode''; a call to
  82 .BR pcap_setnonblock ()
  83 is required in order to put it into ``non-blocking'' mode.
  84 .SH RETURN VALUE
  85 .BR pcap_getnonblock ()
  86 returns the current ``non-blocking'' state of the capture descriptor; it
  87 always returns
  88 .B 0
  89 on ``savefiles''.
  90 If there is an error,
  91 .B PCAP_ERROR
  92 is returned and
  93 .I errbuf
  94 is filled in with an appropriate error message.
  95 .PP
  96 .I errbuf
  97 is assumed to be able to hold at least
  98 .B PCAP_ERRBUF_SIZE
  99 chars.
 100 .SH SEE ALSO
 101 .BR pcap (3PCAP),
 102 .BR pcap_next_ex (3PCAP),
 103 .BR pcap_geterr (3PCAP)