xref: /freebsd/contrib/libpcap/pcap_setdirection.3pcap (revision 9f23cbd6cae82fd77edfad7173432fa8dccd0a95)
Copyright (c) 1994, 1996, 1997
The Regents of the University of California. All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that: (1) source code distributions
retain the above copyright notice and this paragraph in its entirety, (2)
distributions including binary code include the above copyright notice and
this paragraph in its entirety in the documentation or other materials
provided with the distribution, and (3) all advertising materials mentioning
features or use of this software display the following acknowledgement:
``This product includes software developed by the University of California,
Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
the University nor the names of its contributors may be used to endorse
or promote products derived from this software without specific prior
written permission.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

PCAP_SETDIRECTION 3PCAP "5 March 2022"
NAME
pcap_setdirection - set the direction for which packets will be captured
SYNOPSIS
#include <pcap/pcap.h>

int pcap_setdirection(pcap_t *p, pcap_direction_t d);

DESCRIPTION
pcap_setdirection () is used to specify a direction that packets will be captured. d is one of the constants PCAP_D_IN , PCAP_D_OUT or PCAP_D_INOUT . PCAP_D_IN will only capture packets received by the device, PCAP_D_OUT will only capture packets sent by the device and PCAP_D_INOUT will capture packets received by or sent by the device. PCAP_D_INOUT is the default setting if this function is not called.

pcap_setdirection () isn't necessarily fully supported on all platforms; some platforms might return an error for all values, and some other platforms might not support PCAP_D_OUT .

This operation is not supported if a ``savefile'' is being read.

RETURN VALUE
pcap_setdirection () returns 0 on success, PCAP_ERROR_NOT_ACTIVATED if called on a capture handle that has been created but not activated, or PCAP_ERROR on other errors. If PCAP_ERROR is returned, pcap_geterr (3PCAP) or pcap_perror (3PCAP) may be called with p as an argument to fetch or display the error text.
SEE ALSO
pcap (3PCAP)