Module org.pcap4j.core

Package org.pcap4j.packet

Class IcmpV4CommonPacket.IcmpV4CommonHeader

java.lang.Object

org.pcap4j.packet.AbstractPacket.AbstractHeader

org.pcap4j.packet.IcmpV4CommonPacket.IcmpV4CommonHeader

All Implemented Interfaces:

Serializable, Packet.Header

Enclosing class:

IcmpV4CommonPacket

public static final class IcmpV4CommonPacket.IcmpV4CommonHeader
extends AbstractPacket.AbstractHeader

Since:

pcap4j 0.9.11

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private final short	checksum
private static final int	CHECKSUM_OFFSET
private static final int	CHECKSUM_SIZE
private final IcmpV4Code	code
private static final int	CODE_OFFSET
private static final int	CODE_SIZE
private static final int	ICMPV4_COMMON_HEADER_SIZE
private static final long	serialVersionUID
private final IcmpV4Type	type
private static final int	TYPE_OFFSET
private static final int	TYPE_SIZE

Constructor Summary

Constructors

Modifier	Constructor	Description
private	IcmpV4CommonHeader(byte[] rawData, int offset, int length)
private	IcmpV4CommonHeader(IcmpV4CommonPacket.Builder builder, byte[] payload)

Method Summary

Modifier and Type	Method	Description
private byte[]	buildRawData(boolean zeroInsteadOfChecksum)
protected String	buildString()	This method builds the value toString() will return.
private short	calcChecksum(byte[] header, byte[] payload)
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().
short	getChecksum()
IcmpV4Code	getCode()
protected List<byte[]>	getRawFields()	Returns a list of byte arrays which represents this header's fields.
private List<byte[]>	getRawFields(boolean zeroInsteadOfChecksum)
IcmpV4Type	getType()
int	length()	Returns the header length in bytes.

Methods inherited from class org.pcap4j.packet.AbstractPacket.AbstractHeader

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

Methods inherited from class java.lang.Object

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

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

TYPE_OFFSET

private static final int TYPE_OFFSET

See Also:

• Constant Field Values

TYPE_SIZE

private static final int TYPE_SIZE

See Also:

• Constant Field Values

CODE_OFFSET

private static final int CODE_OFFSET

See Also:

• Constant Field Values

CODE_SIZE

private static final int CODE_SIZE

See Also:

• Constant Field Values

CHECKSUM_OFFSET

private static final int CHECKSUM_OFFSET

See Also:

• Constant Field Values

CHECKSUM_SIZE

private static final int CHECKSUM_SIZE

See Also:

• Constant Field Values

ICMPV4_COMMON_HEADER_SIZE

private static final int ICMPV4_COMMON_HEADER_SIZE

See Also:

• Constant Field Values

type

private final IcmpV4Type type

code

private final IcmpV4Code code

checksum

private final short checksum

Constructor Details

IcmpV4CommonHeader

private IcmpV4CommonHeader(byte[] rawData,
 int offset,
 int length)
                    throws IllegalRawDataException

Throws:

IllegalRawDataException

IcmpV4CommonHeader

private IcmpV4CommonHeader(IcmpV4CommonPacket.Builder builder,
 byte[] payload)

Method Details

calcChecksum

private short calcChecksum(byte[] header,
 byte[] payload)

getType

public IcmpV4Type getType()

Returns:

type

getCode

public IcmpV4Code getCode()

Returns:

code

getChecksum

public short getChecksum()

Returns:

checksum

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

getRawFields

private List<byte[]> getRawFields(boolean zeroInsteadOfChecksum)

buildRawData

private byte[] buildRawData(boolean zeroInsteadOfChecksum)

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