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

   1 .\"     $NetBSD: pcap_set_immediate_mode.3pcap,v 1.2 2014/11/19 19:33:30 christos Exp $
   2 .\"
   3 .\"
   4 .\" Copyright (c) 1994, 1996, 1997
   5 .\"     The Regents of the University of California.  All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that: (1) source code distributions
   9 .\" retain the above copyright notice and this paragraph in its entirety, (2)
  10 .\" distributions including binary code include the above copyright notice and
  11 .\" this paragraph in its entirety in the documentation or other materials
  12 .\" provided with the distribution, and (3) all advertising materials mentioning
  13 .\" features or use of this software display the following acknowledgement:
  14 .\" ``This product includes software developed by the University of California,
  15 .\" Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
  16 .\" the University nor the names of its contributors may be used to endorse
  17 .\" or promote products derived from this software without specific prior
  18 .\" written permission.
  19 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
  20 .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
  21 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  22 .\"
  23 .TH PCAP_SET_IMMEDIATE_MODE 3PCAP "8 May 2013"
  24 .SH NAME
  25 pcap_set_immediate_mode \- set immediate mode for a not-yet-activated capture
  26 handle
  27 .SH SYNOPSIS
  28 .nf
  29 .ft B
  30 #include <pcap/pcap.h>
  31 .LP
  32 .ft B
  33 int pcap_set_immediate_mode(pcap_t *p, int immediate_mode);
  34 .ft
  35 .fi
  36 .SH DESCRIPTION
  37 .B pcap_set_immediate_mode()
  38 sets whether immediate mode should be set on a capture handle when
  39 the handle is activated.
  40 If
  41 .I immediate_mode
  42 is non-zero, immediate mode will be set, otherwise it will not be set.
  43 .SH RETURN VALUE
  44 .B pcap_set_immediate_mode()
  45 returns 0 on success or
  46 .B PCAP_ERROR_ACTIVATED
  47 if called on a capture handle that has been activated.
  48 .SH SEE ALSO
  49 pcap(3PCAP), pcap_create(3PCAP), pcap_activate(3PCAP)