contrib/libpcap/pcap_setdirection.3pcap

   1 .\" @(#) $Header: /tcpdump/master/libpcap/pcap_setdirection.3pcap,v 1.3 2008-04-06 02:53:22 guy 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_SETDIRECTION 3PCAP "5 April 2008"
  23 .SH NAME
  24 pcap_setdirection \- set the direction for which packets will be captured
  25 .SH SYNOPSIS
  26 .nf
  27 .ft B
  28 #include <pcap/pcap.h>
  29 .ft
  30 .LP
  31 .ft B
  32 int pcap_setdirection(pcap_t *p, pcap_direction_t d);
  33 .ft
  34 .fi
  35 .SH DESCRIPTION
  36 .B pcap_setdirection()
  37 is used to specify a direction that packets will be captured.
  38 .I d
  39 is one of the constants
  40 .BR PCAP_D_IN ,
  41 .B PCAP_D_OUT
  42 or
  43 .BR PCAP_D_INOUT .
  44 .B PCAP_D_IN
  45 will only capture packets received by the device,
  46 .B PCAP_D_OUT
  47 will only capture packets sent by the device and
  48 .B PCAP_D_INOUT
  49 will capture packets received by or sent by the device.
  50 .B PCAP_D_INOUT
  51 is the default setting if this function is not called.
  52 .PP
  53 .B pcap_setdirection()
  54 isn't necessarily fully supported on all platforms; some platforms might
  55 return an error for all values, and some other platforms might not
  56 support
  57 .BR PCAP_D_OUT .
  58 .PP
  59 This operation is not supported if a ``savefile'' is being read.
  60 .SH RETURN VALUE
  61 .B pcap_setdirection()
  62 returns 0 on success and \-1 on failure.
  63 If \-1 is returned,
  64 .B pcap_geterr()
  65 or
  66 .B pcap_perror()
  67 may be called with
  68 .I p
  69 as an argument to fetch or display the error text.
  70 .SH SEE ALSO
  71 pcap(3PCAP), pcap_geterr(3PCAP)