Blame pcap_set_protocol_linux.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_SET_PROTOCOL_LINUX 3PCAP "24 August 2017"
Packit 209cc3
.SH NAME
Packit 209cc3
pcap_set_protocol_linux \- set capture protocol for a not-yet-activated
Packit 209cc3
capture handle
Packit 209cc3
.SH SYNOPSIS
Packit 209cc3
.nf
Packit 209cc3
.ft B
Packit 209cc3
#include <pcap/pcap.h>
Packit 209cc3
.LP
Packit 209cc3
.ft B
Packit 209cc3
int pcap_set_protocol_linux(pcap_t *p, int protocol);
Packit 209cc3
.ft
Packit 209cc3
.fi
Packit 209cc3
.SH DESCRIPTION
Packit 209cc3
On network interface devices on Linux,
Packit 209cc3
.B pcap_set_protocol_linux()
Packit 209cc3
sets the protocol to be used in the
Packit 209cc3
.BR socket (2)
Packit 209cc3
call to create a capture socket when the handle is activated.  The
Packit 209cc3
argument is a link-layer protocol value, such as the values in the
Packit 209cc3
.B <linux/if_ether.h>
Packit 209cc3
header file, specified in host byte order.
Packit 209cc3
If
Packit 209cc3
.I protocol
Packit 209cc3
is non-zero, packets of that protocol will be captured when the
Packit 209cc3
handle is activated, otherwise, all packets will be captured.  This
Packit 209cc3
function is only provided on Linux, and, if it is used on any device
Packit 209cc3
other than a network interface, it will have no effect.
Packit 209cc3
.LP
Packit 209cc3
It should not be used in portable code; instead, a filter should be
Packit 209cc3
specified with
Packit 209cc3
.BR pcap_setfilter(3PCAP) .
Packit 209cc3
.LP
Packit 209cc3
If a given network interface provides a standard link-layer header, with
Packit 209cc3
a standard packet type, but provides some packet types with a different
Packit 209cc3
socket-layer protocol type from the one in the link-layer header, that
Packit 209cc3
packet type cannot be filtered with a filter specified with
Packit 209cc3
.B pcap_setfilter()
Packit 209cc3
but can be filtered by specifying the socket-layer protocol type using
Packit 209cc3
.BR pcap_set_protocol_linux() .
Packit 209cc3
.SH RETURN VALUE
Packit 209cc3
.B pcap_set_protocol_linux()
Packit 209cc3
returns 0 on success or
Packit 209cc3
.B PCAP_ERROR_ACTIVATED
Packit 209cc3
if called on a capture handle that has been activated.
Packit 209cc3
.SH BACKWARD COMPATIBILITY
Packit 209cc3
This function became available in libpcap release 1.9.0.
Packit 209cc3
.SH SEE ALSO
Packit 209cc3
pcap(3PCAP), pcap_create(3PCAP), pcap_activate(3PCAP)