jnetpcap.capture
Enum CapturedProperty

java.lang.Object
  java.lang.Enum<CapturedProperty>
      jnetpcap.capture.CapturedProperty

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CapturedProperty>

public enum CapturedProperty
extends java.lang.Enum<CapturedProperty>

Enum constants that describe certain properties and thus information a particular type of record may contain. Some implementations may contain additional capabilities not defined by these constants.

Author:

Mark Bednarczyk, Sly Technologies, Inc.

Enum Constant Summary

AnalyzerStatistics
Record contains analyzer produced statistics

CaptureTimestampMicros
Record contains capture a timestamps of fraction of a seconds in micros.

CaptureTimestampNanos
Record contains capture a timestamps of fraction of a seconds in nanos.

CaptureTimestampSeconds
Record contains capture a timestamps in seconds

EntityTimezone
Timezone information about the capture entity or capture system is known.

FileCompression
Record contains a compression algorithm information to compress the files content

FileEncryption
Record contains information about file encryption algorithm.

FileMagicNumber
Record contains a MAGIC number specific for this file type.

FilePaceholder

FilePassword
Record contains a password to protect the file

FileVersion
Record contains version information about the file or block within the file.

InPlaceMutableBlock
Block contents can be mutated in place without file copies (size and content can change)

InterfaceCounterDrops
Record contains interface packet drops counter

InterfaceCounterInOctects
Record contains interface ingres octets counters.

InterfaceCounterInPackets
Record contains interface ingres packet counter

InterfaceCounterOutOctects
Record contains interface egress octet counter.

InterfaceCounterOutPackets
Record contains interface egress packet counter

PacketBuffer
Record contains a packet buffer with packet data.

PacketProtocol
Record contains information about PacketProtocol, the first protocol, usually linktype, within the PacketBuffer.

UserProperties
Record contains user properties in AV pair format "property = value"

Method Summary

static CapturedProperty	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CapturedProperty[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PacketBuffer

public static final CapturedProperty PacketBuffer

Record contains a packet buffer with packet data.

PacketProtocol

public static final CapturedProperty PacketProtocol

Record contains information about PacketProtocol, the first protocol, usually linktype, within the PacketBuffer.

CaptureTimestampSeconds

public static final CapturedProperty CaptureTimestampSeconds

Record contains capture a timestamps in seconds

CaptureTimestampMicros

public static final CapturedProperty CaptureTimestampMicros

Record contains capture a timestamps of fraction of a seconds in micros. Legal value is between 0 and 999,999 inclusive

CaptureTimestampNanos

public static final CapturedProperty CaptureTimestampNanos

Record contains capture a timestamps of fraction of a seconds in nanos. Legal value is between 0 and 999,999,999 inclusive

EntityTimezone

public static final CapturedProperty EntityTimezone

Timezone information about the capture entity or capture system is known. For remote capture systems, the timezone may be different.

InterfaceCounterDrops

public static final CapturedProperty InterfaceCounterDrops

Record contains interface packet drops counter

InterfaceCounterInPackets

public static final CapturedProperty InterfaceCounterInPackets

Record contains interface ingres packet counter

InterfaceCounterInOctects

public static final CapturedProperty InterfaceCounterInOctects

Record contains interface ingres octets counters. Bytes received.

InterfaceCounterOutPackets

public static final CapturedProperty InterfaceCounterOutPackets

Record contains interface egress packet counter

InterfaceCounterOutOctects

public static final CapturedProperty InterfaceCounterOutOctects

Record contains interface egress octet counter. Bytes sent.

FilePassword

public static final CapturedProperty FilePassword

Record contains a password to protect the file

FileCompression

public static final CapturedProperty FileCompression

Record contains a compression algorithm information to compress the files content

FileEncryption

public static final CapturedProperty FileEncryption

Record contains information about file encryption algorithm.

UserProperties

public static final CapturedProperty UserProperties

Record contains user properties in AV pair format "property = value"

FileVersion

public static final CapturedProperty FileVersion

Record contains version information about the file or block within the file.

FileMagicNumber

public static final CapturedProperty FileMagicNumber

Record contains a MAGIC number specific for this file type.

AnalyzerStatistics

public static final CapturedProperty AnalyzerStatistics

Record contains analyzer produced statistics

InPlaceMutableBlock

public static final CapturedProperty InPlaceMutableBlock

Block contents can be mutated in place without file copies (size and content can change)

FilePaceholder

public static final CapturedProperty FilePaceholder

Method Detail

values

public static final CapturedProperty[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(CapturedProperty c : CapturedProperty.values())
        System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they're declared

valueOf

public static CapturedProperty valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name