external/bsd/libpcap/dist/pcap_setnonblock.3pcap

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