Module org.pcap4j.core

Package org.pcap4j.packet

Class IcmpV4CommonPacket

java.lang.Object

org.pcap4j.packet.AbstractPacket

org.pcap4j.packet.IcmpV4CommonPacket

All Implemented Interfaces:

Serializable, Iterable<Packet>, Packet

public final class IcmpV4CommonPacket
extends AbstractPacket

Since:

pcap4j 0.9.11

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	IcmpV4CommonPacket.Builder
static final class	IcmpV4CommonPacket.IcmpV4CommonHeader

Nested classes/interfaces inherited from class org.pcap4j.packet.AbstractPacket

AbstractPacket.AbstractBuilder, AbstractPacket.AbstractHeader

Nested classes/interfaces inherited from interface org.pcap4j.packet.Packet

Packet.Header

Field Summary

Fields

Modifier and Type	Field	Description
private final IcmpV4CommonPacket.IcmpV4CommonHeader	header
private final Packet	payload
private static final long	serialVersionUID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
IcmpV4CommonPacket.Builder	getBuilder()	Returns a new Builder object populated with this object's fields' values.
IcmpV4CommonPacket.IcmpV4CommonHeader	getHeader()	Returns the Header object representing this packet's header.
Packet	getPayload()	Returns the Packet object representing this packet's payload.
boolean	hasValidChecksum(boolean acceptZero)
static IcmpV4CommonPacket	newPacket(byte[] rawData, int offset, int length)	A static factory method.

Methods inherited from class org.pcap4j.packet.AbstractPacket

buildHexString, buildRawData, buildString, calcHashCode, calcLength, contains, equals, get, getOuterOf, getRawData, hashCode, iterator, length, toHexString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

header

private final IcmpV4CommonPacket.IcmpV4CommonHeader header

payload

private final Packet payload

Constructor Details

IcmpV4CommonPacket

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

Throws:

IllegalRawDataException

IcmpV4CommonPacket

private IcmpV4CommonPacket(IcmpV4CommonPacket.Builder builder)

Method Details

newPacket

public static IcmpV4CommonPacket newPacket(byte[] rawData,
 int offset,
 int length)
                                    throws IllegalRawDataException

A static factory method. This method validates the arguments by ByteArrays.validateBounds(byte[], int, int), which may throw exceptions undocumented here.

Parameters:

rawData - rawData

offset - offset

length - length

Returns:

a new IcmpV4CommonPacket object.

Throws:

IllegalRawDataException - if parsing the raw data fails.

getHeader

public IcmpV4CommonPacket.IcmpV4CommonHeader getHeader()

Description copied from class: AbstractPacket

Returns the Header object representing this packet's header. This subclass have to override this method if the packet represented by the subclass has a header.

Specified by:

getHeader in interface Packet

Overrides:

getHeader in class AbstractPacket

Returns:

the Header object representing this packet's header. May be null if the header doesn't exist

getPayload

public Packet getPayload()

Description copied from class: AbstractPacket

Returns the Packet object representing this packet's payload. This subclass have to override this method if the packet represented by the subclass has a payload.

Specified by:

getPayload in interface Packet

Overrides:

getPayload in class AbstractPacket

Returns:

the Packet object representing this packet's payload. May be null if the payload doesn't exist

getBuilder

public IcmpV4CommonPacket.Builder getBuilder()

Description copied from interface: Packet

Returns a new Builder object populated with this object's fields' values.

Specified by:

getBuilder in interface Packet

Specified by:

getBuilder in class AbstractPacket

Returns:

a new Builder object populated with this object's fields values

hasValidChecksum

public boolean hasValidChecksum(boolean acceptZero)

Parameters:

acceptZero - acceptZero

Returns:

true if the packet represented by this object has a valid checksum; false otherwise.