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