Module org.jnetpcap

Package org.jnetpcap.internal

Enum Class PcapHeaderABI

java.lang.Object

java.lang.Enum<PcapHeaderABI>

org.jnetpcap.internal.PcapHeaderABI

All Implemented Interfaces:

Serializable, Comparable<PcapHeaderABI>, Constable

public enum PcapHeaderABI
extends Enum<PcapHeaderABI>

Configures different ABI (Application Binary Interfaces) for access to binary pcap header data. On 64-bit architectures the header structure in native memory received from libpcap will be padded to end up with 24 byte header length. When stored in ''savefiles'' and handling in non native storage will be represented as 16 byte compact structure. Note that MemoryLayouts are actually harder to use in this case. Thus we poke the values directly, plus its more efficient this way.

Author:

Sly Technologies Inc, repos@slytechs.com, mark

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMPACT_BE	The compact be.
COMPACT_LE	The compact le.
PADDED_BE	The padded be.
PADDED_LE	The padded le.

Method Summary

Modifier and Type	Method	Description
int	captureLength(MemorySegment mseg)	Capture length.
void	captureLength(MemorySegment mseg, int newLength)	Capture length.
int	captureLength(ByteBuffer buffer)	Capture length.
int	captureLengthOffset()	Capture length offset.
static PcapHeaderABI	compactAbi()	Compact abi.
static PcapHeaderABI	compactAbi(boolean isSwapped)	Compact abi.
static PcapHeaderABI	compactAbi(ByteOrder bo)	Compact abi.
int	headerLength()	Actual, in memory, header length as per this ABI and compiler padding.
static PcapHeaderABI	nativeAbi()	Native abi.
static PcapHeaderABI	nativeAbi(ByteOrder bo)	Native abi.
ByteOrder	order()	Order.
static PcapHeaderABI	paddedAbi()	Padded abi.
static PcapHeaderABI	selectDeadAbi()	Select dead abi.
static PcapHeaderABI	selectLiveAbi()	Select live abi.
static PcapHeaderABI	selectOfflineAbi(boolean isSwapped)	Select offline abi.
static PcapHeaderException	throwListOfAllAbiPossibilities(ByteBuffer buffer, PcapHeaderException.OutOfRangeException cause, String name, BiFunction<PcapHeaderABI,ByteBuffer,Integer> action)	Throw list of all abi possibilities.
long	tvSec(MemorySegment mseg)	Tv sec.
void	tvSec(MemorySegment mseg, long newTvSec)	Tv sec.
int	tvSecOffset()	Tv sec offset.
long	tvUsec(MemorySegment mseg)	Tv usec.
void	tvUsec(MemorySegment mseg, long newTvUsec)	Tv usec.
int	tvUsecOffset()	Tv usec offset.
static PcapHeaderABI	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PcapHeaderABI[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
int	wireLength(MemorySegment mseg)	Wire length.
void	wireLength(MemorySegment mseg, int newLength)	Wire length.
int	wireLength(ByteBuffer buffer)	Wire length.
int	wireLengthOffset()	Wire length offset.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

COMPACT_LE

public static final PcapHeaderABI COMPACT_LE

The compact le.

COMPACT_BE

public static final PcapHeaderABI COMPACT_BE

The compact be.

PADDED_LE

public static final PcapHeaderABI PADDED_LE

The padded le.

PADDED_BE

public static final PcapHeaderABI PADDED_BE

The padded be.

Method Details

values

public static PcapHeaderABI[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static PcapHeaderABI valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

compactAbi

public static PcapHeaderABI compactAbi()

Compact abi.

Returns:

the pcap header ABI

compactAbi

public static PcapHeaderABI compactAbi(boolean isSwapped)

Compact abi.

Parameters:

isSwapped - the is swapped

Returns:

the pcap header ABI

compactAbi

public static PcapHeaderABI compactAbi(ByteOrder bo)

Compact abi.

Parameters:

bo - the bo

Returns:

the pcap header ABI

nativeAbi

public static PcapHeaderABI nativeAbi()

Native abi.

Returns:

the pcap header ABI

nativeAbi

public static PcapHeaderABI nativeAbi(ByteOrder bo)

Native abi.

Parameters:

bo - the bo

Returns:

the pcap header ABI

paddedAbi

public static PcapHeaderABI paddedAbi()

Padded abi.

Returns:

the pcap header ABI

selectDeadAbi

public static PcapHeaderABI selectDeadAbi()

Select dead abi.

Returns:

the pcap header ABI

selectLiveAbi

public static PcapHeaderABI selectLiveAbi()

Select live abi.

Returns:

the pcap header ABI

selectOfflineAbi

public static PcapHeaderABI selectOfflineAbi(boolean isSwapped)

Select offline abi.

Parameters:

isSwapped - the is swapped

Returns:

the pcap header ABI

throwListOfAllAbiPossibilities

public static PcapHeaderException throwListOfAllAbiPossibilities(ByteBuffer buffer,
 PcapHeaderException.OutOfRangeException cause,
 String name,
 BiFunction<PcapHeaderABI,ByteBuffer,Integer> action)
                                                          throws PcapHeaderException

Throw list of all abi possibilities.

Parameters:

buffer - the buffer

cause - the cause

name - the name

action - the action

Returns:

the pcap header exception

Throws:

PcapHeaderException - the pcap header exception

captureLength

public int captureLength(ByteBuffer buffer)

Capture length.

Parameters:

buffer - the buffer

Returns:

the int

captureLength

public int captureLength(MemorySegment mseg)

Capture length.

Parameters:

mseg - the mseg

Returns:

the int

captureLength

public void captureLength(MemorySegment mseg,
 int newLength)

Capture length.

Parameters:

mseg - the mseg

newLength - the new length

captureLengthOffset

public int captureLengthOffset()

Capture length offset.

Returns:

the int

headerLength

public int headerLength()

Actual, in memory, header length as per this ABI and compiler padding.

Returns:

the int

order

public ByteOrder order()

Order.

Returns:

the byte order

tvSec

public long tvSec(MemorySegment mseg)

Tv sec.

Parameters:

mseg - the mseg

Returns:

the long

tvSec

public void tvSec(MemorySegment mseg,
 long newTvSec)

Tv sec.

Parameters:

mseg - the mseg

newTvSec - the new tv sec

tvSecOffset

public int tvSecOffset()

Tv sec offset.

Returns:

the int

tvUsec

public long tvUsec(MemorySegment mseg)

Tv usec.

Parameters:

mseg - the mseg

Returns:

the long

tvUsec

public void tvUsec(MemorySegment mseg,
 long newTvUsec)

Tv usec.

Parameters:

mseg - the mseg

newTvUsec - the new tv usec

tvUsecOffset

public int tvUsecOffset()

Tv usec offset.

Returns:

the int

wireLength

public int wireLength(ByteBuffer buffer)

Wire length.

Parameters:

buffer - the buffer

Returns:

the int

wireLength

public int wireLength(MemorySegment mseg)

Wire length.

Parameters:

mseg - the mseg

Returns:

the int

wireLength

public void wireLength(MemorySegment mseg,
 int newLength)

Wire length.

Parameters:

mseg - the mseg

newLength - the new length

wireLengthOffset

public int wireLengthOffset()

Wire length offset.

Returns:

the int