Blame pcap_setdirection.3pcap

Packit 209cc3
.\" Copyright (c) 1994, 1996, 1997
Packit 209cc3
.\"	The Regents of the University of California.  All rights reserved.
Packit 209cc3
.\"
Packit 209cc3
.\" Redistribution and use in source and binary forms, with or without
Packit 209cc3
.\" modification, are permitted provided that: (1) source code distributions
Packit 209cc3
.\" retain the above copyright notice and this paragraph in its entirety, (2)
Packit 209cc3
.\" distributions including binary code include the above copyright notice and
Packit 209cc3
.\" this paragraph in its entirety in the documentation or other materials
Packit 209cc3
.\" provided with the distribution, and (3) all advertising materials mentioning
Packit 209cc3
.\" features or use of this software display the following acknowledgement:
Packit 209cc3
.\" ``This product includes software developed by the University of California,
Packit 209cc3
.\" Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
Packit 209cc3
.\" the University nor the names of its contributors may be used to endorse
Packit 209cc3
.\" or promote products derived from this software without specific prior
Packit 209cc3
.\" written permission.
Packit 209cc3
.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
Packit 209cc3
.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
Packit 209cc3
.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
Packit 209cc3
.\"
Packit 209cc3
.TH PCAP_SETDIRECTION 3PCAP "25 July 2018"
Packit 209cc3
.SH NAME
Packit 209cc3
pcap_setdirection \- set the direction for which packets will be captured
Packit 209cc3
.SH SYNOPSIS
Packit 209cc3
.nf
Packit 209cc3
.ft B
Packit 209cc3
#include <pcap/pcap.h>
Packit 209cc3
.ft
Packit 209cc3
.LP
Packit 209cc3
.ft B
Packit 209cc3
int pcap_setdirection(pcap_t *p, pcap_direction_t d);
Packit 209cc3
.ft
Packit 209cc3
.fi
Packit 209cc3
.SH DESCRIPTION
Packit 209cc3
.B pcap_setdirection()
Packit 209cc3
is used to specify a direction that packets will be captured.
Packit 209cc3
.I d
Packit 209cc3
is one of the constants
Packit 209cc3
.BR PCAP_D_IN ,
Packit 209cc3
.B PCAP_D_OUT
Packit 209cc3
or
Packit 209cc3
.BR PCAP_D_INOUT .
Packit 209cc3
.B PCAP_D_IN
Packit 209cc3
will only capture packets received by the device,
Packit 209cc3
.B PCAP_D_OUT
Packit 209cc3
will only capture packets sent by the device and
Packit 209cc3
.B PCAP_D_INOUT
Packit 209cc3
will capture packets received by or sent by the device.
Packit 209cc3
.B PCAP_D_INOUT
Packit 209cc3
is the default setting if this function is not called.
Packit 209cc3
.PP
Packit 209cc3
.B pcap_setdirection()
Packit 209cc3
isn't necessarily fully supported on all platforms; some platforms might
Packit 209cc3
return an error for all values, and some other platforms might not
Packit 209cc3
support
Packit 209cc3
.BR PCAP_D_OUT .
Packit 209cc3
.PP
Packit 209cc3
This operation is not supported if a ``savefile'' is being read.
Packit 209cc3
.SH RETURN VALUE
Packit 209cc3
.B pcap_setdirection()
Packit 209cc3
returns 0 on success and
Packit 209cc3
.B PCAP_ERROR
Packit 209cc3
on failure. If
Packit 209cc3
.B PCAP_ERROR
Packit 209cc3
is returned,
Packit 209cc3
.B pcap_geterr(3PCAP)
Packit 209cc3
or
Packit 209cc3
.B pcap_perror(3PCAP)
Packit 209cc3
may be called with
Packit 209cc3
.I p
Packit 209cc3
as an argument to fetch or display the error text.
Packit 209cc3
.SH SEE ALSO
Packit 209cc3
pcap(3PCAP)