contrib/libpcap/pcap_set_immediate_mode.3pcap

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