PcapGlobalHeader (Core Pkts 3.0.10 API)

java.lang.Object
- io.pkts.frame.PcapGlobalHeader

public final class PcapGlobalHeader
extends Object

Author:: jonas@jonasborjesson.com

Field Summary

Fields
Modifier and Type	Field and Description
`static byte[]`	`MAGIC_BIG_ENDIAN` See http://wiki.wireshark.org/Development/LibpcapFileFormat
`static byte[]`	`MAGIC_LITTLE_ENDIAN` See http://wiki.wireshark.org/Development/LibpcapFileFormat
`static byte[]`	`MAGIC_MODIFIED` Found the following at: http://anonsvn.wireshark.org/wireshark/trunk/wiretap/libpcap.h PCAP_MODIFIED_MAGIC is for Alexey Kuznetsov's modified "libpcap" format, as generated on Linux systems that have a "libpcap" with his patches, at http://ftp.sunet.se/pub/os/Linux/ip-routing/lbl-tools/ applied; PCAP_SWAPPED_MODIFIED_MAGIC is the byte-swapped version.
`static byte[]`	`MAGIC_MODIFIED_SWAPPED`
`static byte[]`	`MAGIC_NGPCAP` New pcap format
`static byte[]`	`MAGIC_NSEC` Found the following at: http://anonsvn.wireshark.org/wireshark/trunk/wiretap/libpcap.h PCAP_NSEC_MAGIC is for Ulf Lamping's modified "libpcap" format, which uses the same common file format as PCAP_MAGIC, but the timestamps are saved in nanosecond resolution instead of microseconds.
`static byte[]`	`MAGIC_NSEC_SWAPPED`
`static int`	`SIZE` pcap_hdr_s struct is SIZE bytes long.

Constructor Summary

Constructors
Constructor and Description
`PcapGlobalHeader(ByteOrder byteOrder, byte[] body)`
`PcapGlobalHeader(ByteOrder byteOrder, byte[] body, boolean nsTimestamps)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static PcapGlobalHeader`	`createDefaultHeader()` Factory method for creating a default `PcapGlobalHeader`.
`static PcapGlobalHeader`	`createDefaultHeader(Protocol protocol)`
`ByteOrder`	`getByteOrder()`
`int`	`getDataLinkType()`
`static int`	`getInt(int offset, byte[] buffer, ByteOrder byteOrder)`
`int`	`getMajorVersion()` Major version is currently 2
`int`	`getMinorVersion()` Minor version is currently 4
`long`	`getSnapLength()` the "snapshot length" for the capture (typically 65535 or even more, but might be limited by the user)
`int`	`getTimeAccuracy()` in theory, the accuracy of time stamps in the capture; in practice, all tools set it to 0
`long`	`getTimeZoneCorrection()` The correction time in seconds between GMT (UTC) and the local timezone of the following packet header timestamps.
`static long`	`getUnsignedInt(int offset, byte[] buffer, ByteOrder byteOrder)`
`static int`	`getUnsignedShort(int offset, byte[] buffer, ByteOrder byteOrder)`
`static PcapGlobalHeader`	`parse(Buffer in)`
`boolean`	`timestampsInNs()`
`String`	`toString()`
`static long`	`unsignedInt(byte a, byte b, byte c, byte d)`
`void`	`write(OutputStream out)` Will write this header to the output stream.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - SIZE
```
public static final int SIZE
```
    pcap_hdr_s struct is SIZE bytes long.
    
    See Also:
    
    Constant Field Values
  - MAGIC_BIG_ENDIAN
```
public static final byte[] MAGIC_BIG_ENDIAN
```
    See http://wiki.wireshark.org/Development/LibpcapFileFormat
  - MAGIC_LITTLE_ENDIAN
```
public static final byte[] MAGIC_LITTLE_ENDIAN
```
    See http://wiki.wireshark.org/Development/LibpcapFileFormat
  - MAGIC_NGPCAP
```
public static final byte[] MAGIC_NGPCAP
```
    New pcap format
  - MAGIC_NSEC
```
public static final byte[] MAGIC_NSEC
```
    Found the following at: http://anonsvn.wireshark.org/wireshark/trunk/wiretap/libpcap.h PCAP_NSEC_MAGIC is for Ulf Lamping's modified "libpcap" format, which uses the same common file format as PCAP_MAGIC, but the timestamps are saved in nanosecond resolution instead of microseconds.
  - MAGIC_NSEC_SWAPPED
```
public static final byte[] MAGIC_NSEC_SWAPPED
```
  - MAGIC_MODIFIED
```
public static final byte[] MAGIC_MODIFIED
```
    Found the following at: http://anonsvn.wireshark.org/wireshark/trunk/wiretap/libpcap.h PCAP_MODIFIED_MAGIC is for Alexey Kuznetsov's modified "libpcap" format, as generated on Linux systems that have a "libpcap" with his patches, at http://ftp.sunet.se/pub/os/Linux/ip-routing/lbl-tools/ applied; PCAP_SWAPPED_MODIFIED_MAGIC is the byte-swapped version.
  - MAGIC_MODIFIED_SWAPPED
```
public static final byte[] MAGIC_MODIFIED_SWAPPED
```
- Constructor Detail
  - PcapGlobalHeader
```
public PcapGlobalHeader(ByteOrder byteOrder,
                        byte[] body)
```
  - PcapGlobalHeader
```
public PcapGlobalHeader(ByteOrder byteOrder,
                        byte[] body,
                        boolean nsTimestamps)
```
- Method Detail
  - createDefaultHeader
```
public static PcapGlobalHeader createDefaultHeader()
```
    Factory method for creating a default PcapGlobalHeader. Mainly used for when writing out new pcaps to a stream.
    
    Returns:
  - createDefaultHeader
```
public static PcapGlobalHeader createDefaultHeader(Protocol protocol)
```
  - getByteOrder
```
public ByteOrder getByteOrder()
```
  - timestampsInNs
```
public boolean timestampsInNs()
```
  - getMajorVersion
```
public int getMajorVersion()
```
    Major version is currently 2
    
    Returns:
  - getMinorVersion
```
public int getMinorVersion()
```
    Minor version is currently 4
    
    Returns:
  - getTimeAccuracy
```
public int getTimeAccuracy()
```
    in theory, the accuracy of time stamps in the capture; in practice, all tools set it to 0
    
    Returns:
  - getTimeZoneCorrection
```
public long getTimeZoneCorrection()
```
    The correction time in seconds between GMT (UTC) and the local timezone of the following packet header timestamps. Examples: If the timestamps are in GMT (UTC), thiszone is simply 0. If the timestamps are in Central European time (Amsterdam, Berlin, ...) which is GMT + 1:00, thiszone must be -3600. In practice, time stamps are always in GMT, so thiszone is always 0.
    
    Returns:
  - getSnapLength
```
public long getSnapLength()
```
    the "snapshot length" for the capture (typically 65535 or even more, but might be limited by the user)
    
    Returns:
  - getDataLinkType
```
public int getDataLinkType()
```
  - getUnsignedShort
```
public static final int getUnsignedShort(int offset,
                                         byte[] buffer,
                                         ByteOrder byteOrder)
```
  - getUnsignedInt
```
public static final long getUnsignedInt(int offset,
                                        byte[] buffer,
                                        ByteOrder byteOrder)
```
  - getInt
```
public static final int getInt(int offset,
                               byte[] buffer,
                               ByteOrder byteOrder)
```
  - parse
```
public static final PcapGlobalHeader parse(Buffer in)
                                    throws IOException
```
    Throws:
    
    IOException
  - write
```
public void write(OutputStream out)
           throws IOException
```
    Will write this header to the output stream.
    
    Parameters:
    
    out -
    
    Throws:
    
    IOException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - unsignedInt
```
public static long unsignedInt(byte a,
                               byte b,
                               byte c,
                               byte d)
```

Class PcapGlobalHeader

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SIZE

MAGIC_BIG_ENDIAN

MAGIC_LITTLE_ENDIAN

MAGIC_NGPCAP

MAGIC_NSEC

MAGIC_NSEC_SWAPPED

MAGIC_MODIFIED

MAGIC_MODIFIED_SWAPPED

Constructor Detail

PcapGlobalHeader

PcapGlobalHeader

Method Detail

createDefaultHeader

createDefaultHeader

getByteOrder

timestampsInNs

getMajorVersion

getMinorVersion

getTimeAccuracy

getTimeZoneCorrection

getSnapLength

getDataLinkType

getUnsignedShort

getUnsignedInt

getInt

parse

write

toString

unsignedInt