Blame pcap_datalink.3pcap.in

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_DATALINK 3PCAP "7 April 2014"
Packit 209cc3
.SH NAME
Packit 209cc3
pcap_datalink \- get the link-layer header type
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_datalink(pcap_t *p);
Packit 209cc3
.ft
Packit 209cc3
.fi
Packit 209cc3
.SH DESCRIPTION
Packit 209cc3
.B pcap_datalink()
Packit 209cc3
returns the link-layer header type for the live capture or ``savefile''
Packit 209cc3
specified by
Packit 209cc3
.IR p .
Packit 209cc3
.PP
Packit 209cc3
It must not be called on a pcap descriptor created by
Packit 209cc3
.B \%pcap_create(3PCAP)
Packit 209cc3
that has not yet been activated by
Packit 209cc3
.BR \%pcap_activate(3PCAP) .
Packit 209cc3
.PP
Packit 209cc3
.I https://www.tcpdump.org/linktypes.html
Packit 209cc3
lists the values
Packit 209cc3
.B pcap_datalink()
Packit 209cc3
can return and describes the packet formats that
Packit 209cc3
correspond to those values.
Packit 209cc3
.PP
Packit 209cc3
Do
Packit 209cc3
.B NOT
Packit 209cc3
assume that the packets for a given capture or ``savefile`` will have
Packit 209cc3
any given link-layer header type, such as
Packit 209cc3
.B DLT_EN10MB
Packit 209cc3
for Ethernet.  For example, the "any" device on Linux will have a
Packit 209cc3
link-layer header type of
Packit 209cc3
.B DLT_LINUX_SLL
Packit 209cc3
even if all devices on the system at the time the "any" device is opened
Packit 209cc3
have some other data link type, such as
Packit 209cc3
.B DLT_EN10MB
Packit 209cc3
for Ethernet.
Packit 209cc3
.SH RETURN VALUE
Packit 209cc3
.B pcap_datalink()
Packit 209cc3
returns the link-layer header type on success and
Packit 209cc3
.B PCAP_ERROR_NOT_ACTIVATED
Packit 209cc3
if called on a capture handle that has been created but not activated.
Packit 209cc3
.SH SEE ALSO
Packit 209cc3
pcap(3PCAP), pcap-linktype(@MAN_MISC_INFO@)