contrib/libpcap/pcap_datalink.3pcap.in

   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_DATALINK 3PCAP "7 April 2014"
  21 .SH NAME
  22 pcap_datalink \- get the link-layer header type
  23 .SH SYNOPSIS
  24 .nf
  25 .ft B
  26 #include <pcap/pcap.h>
  27 .ft
  28 .LP
  29 .ft B
  30 int pcap_datalink(pcap_t *p);
  31 .ft
  32 .fi
  33 .SH DESCRIPTION
  34 .B pcap_datalink()
  35 returns the link-layer header type for the live capture or ``savefile''
  36 specified by
  37 .IR p .
  38 .PP
  39 It must not be called on a pcap descriptor created by
  40 .B \%pcap_create(3PCAP)
  41 that has not yet been activated by
  42 .BR \%pcap_activate(3PCAP) .
  43 .PP
  44 .I https://www.tcpdump.org/linktypes.html
  45 lists the values
  46 .B pcap_datalink()
  47 can return and describes the packet formats that
  48 correspond to those values.
  49 .PP
  50 Do
  51 .B NOT
  52 assume that the packets for a given capture or ``savefile`` will have
  53 any given link-layer header type, such as
  54 .B DLT_EN10MB
  55 for Ethernet.  For example, the "any" device on Linux will have a
  56 link-layer header type of
  57 .B DLT_LINUX_SLL
  58 even if all devices on the system at the time the "any" device is opened
  59 have some other data link type, such as
  60 .B DLT_EN10MB
  61 for Ethernet.
  62 .SH RETURN VALUE
  63 .B pcap_datalink()
  64 returns the link-layer header type on success and
  65 .B PCAP_ERROR_NOT_ACTIVATED
  66 if called on a capture handle that has been created but not activated.
  67 .SH SEE ALSO
  68 pcap(3PCAP), pcap-linktype(@MAN_MISC_INFO@)