Class IcmpIdentifiablePacket.IcmpIdentifiableHeader

java.lang.Object

org.pcap4j.packet.AbstractPacket.AbstractHeader

org.pcap4j.packet.IcmpIdentifiablePacket.IcmpIdentifiableHeader

All Implemented Interfaces:

Serializable, Packet.Header

Direct Known Subclasses:

IcmpV4EchoPacket.IcmpV4EchoHeader, IcmpV4EchoReplyPacket.IcmpV4EchoReplyHeader, IcmpV4InformationReplyPacket.IcmpV4InformationReplyHeader, IcmpV4InformationRequestPacket.IcmpV4InformationRequestHeader, IcmpV4TimestampPacket.IcmpV4TimestampHeader, IcmpV4TimestampReplyPacket.IcmpV4TimestampReplyHeader, IcmpV6EchoReplyPacket.IcmpV6EchoReplyHeader, IcmpV6EchoRequestPacket.IcmpV6EchoRequestHeader

Enclosing class:

IcmpIdentifiablePacket

abstract static class IcmpIdentifiablePacket.IcmpIdentifiableHeader
extends AbstractPacket.AbstractHeader

Since:

pcap4j 0.9.11

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	ICMP_IDENTIFIABLE_HEADER_SIZE
private final short	identifier
private static final int	IDENTIFIER_OFFSET
private static final int	IDENTIFIER_SIZE
private static final int	SEQUENCE_NUMBER_OFFSET
private static final int	SEQUENCE_NUMBER_SIZE
private final short	sequenceNumber
private static final long	serialVersionUID

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	IcmpIdentifiableHeader(byte[] rawData, int offset, int length)
protected	IcmpIdentifiableHeader(IcmpIdentifiablePacket.Builder builder)

Method Summary

Modifier and Type	Method	Description
protected String	buildString()	This method builds the value toString() will return.
protected int	calcHashCode()	This method builds the value hashCode() will return using the byte array getRawData() returns.
boolean	equals(Object obj)	Indicates whether some other object is "equal to" this one using return values of getRawData().
protected abstract String	getHeaderName()
short	getIdentifier()
int	getIdentifierAsInt()
protected List<byte[]>	getRawFields()	Returns a list of byte arrays which represents this header's fields.
short	getSequenceNumber()
int	getSequenceNumberAsInt()
int	length()	Returns the header length in bytes.

Methods inherited from class AbstractPacket.AbstractHeader

buildHexString, buildRawData, calcLength, getRawData, hashCode, toHexString, toString

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

IDENTIFIER_OFFSET

private static final int IDENTIFIER_OFFSET

See Also:

• Constant Field Values

IDENTIFIER_SIZE

private static final int IDENTIFIER_SIZE

See Also:

• Constant Field Values

SEQUENCE_NUMBER_OFFSET

private static final int SEQUENCE_NUMBER_OFFSET

See Also:

• Constant Field Values

SEQUENCE_NUMBER_SIZE

private static final int SEQUENCE_NUMBER_SIZE

See Also:

• Constant Field Values

ICMP_IDENTIFIABLE_HEADER_SIZE

protected static final int ICMP_IDENTIFIABLE_HEADER_SIZE

See Also:

• Constant Field Values

identifier

private final short identifier

sequenceNumber

private final short sequenceNumber

Constructor Details

IcmpIdentifiableHeader

protected IcmpIdentifiableHeader(byte[] rawData,
 int offset,
 int length)
                          throws IllegalRawDataException

Throws:

IllegalRawDataException

IcmpIdentifiableHeader

protected IcmpIdentifiableHeader(IcmpIdentifiablePacket.Builder builder)

Method Details

getIdentifier

public short getIdentifier()

Returns:

identifier

getIdentifierAsInt

public int getIdentifierAsInt()

Returns:

identifier

getSequenceNumber

public short getSequenceNumber()

Returns:

sequenceNumber

getSequenceNumberAsInt

public int getSequenceNumberAsInt()

Returns:

sequenceNumber

getRawFields

protected List<byte[]> getRawFields()

Description copied from class: AbstractPacket.AbstractHeader

Returns a list of byte arrays which represents this header's fields. This method is called by calcLength() and buildRawData().

Specified by:

getRawFields in class AbstractPacket.AbstractHeader

Returns:

a list of byte arrays which represents this header's fields

length

public int length()

Description copied from class: AbstractPacket.AbstractHeader

Returns the header length in bytes. This method calls calcLength() and caches the return value when it is called for the first time, and then, this method returns the cached value from the second time.

Specified by:

length in interface Packet.Header

Overrides:

length in class AbstractPacket.AbstractHeader

Returns:

the length of the byte stream of the header represented by this object in bytes

buildString

protected String buildString()

Description copied from class: AbstractPacket.AbstractHeader

This method builds the value toString() will return.

Overrides:

buildString in class AbstractPacket.AbstractHeader

Returns:

a string representation of this object

equals

public boolean equals(Object obj)

Description copied from class: AbstractPacket.AbstractHeader

Indicates whether some other object is "equal to" this one using return values of getRawData(). This method should be overridden so that it does more strict comparisons more efficiently.

Overrides:

equals in class AbstractPacket.AbstractHeader

calcHashCode

protected int calcHashCode()

Description copied from class: AbstractPacket.AbstractHeader

This method builds the value hashCode() will return using the byte array getRawData() returns. This method may be better to be overridden for performance reason.

Overrides:

calcHashCode in class AbstractPacket.AbstractHeader

Returns:

a calculated hash code value for the object

getHeaderName

protected abstract String getHeaderName()