org.onlab.packet

Class ICMP

java.lang.Object

org.onlab.packet.BasePacket

org.onlab.packet.ICMP

All Implemented Interfaces:

IPacket

public class ICMP
extends BasePacket

Implements ICMP packet format.

Field Summary

Fields

Modifier and Type	Field and Description
protected short	checksum
static short	ICMP_HEADER_LENGTH
protected byte	icmpCode
protected byte	icmpType
static byte	SUBTYPE_ECHO_REPLY
static byte	TYPE_ECHO_REPLY
static byte	TYPE_ECHO_REQUEST

Fields inherited from class org.onlab.packet.BasePacket

parent, payload

Constructor Summary

Constructors

Constructor and Description
ICMP()

Method Summary

Modifier and Type	Method and Description
IPacket	deserialize(byte[] data, int offset, int length) Deserializes this packet layer and all possible payloads.
static Deserializer<ICMP>	deserializer() Deserializer function for ICMP packets.
boolean	equals(Object obj)
short	getChecksum()
byte	getIcmpCode()
byte	getIcmpType()
int	hashCode()
byte[]	serialize() Serializes the packet.
ICMP	setChecksum(short checksum)
ICMP	setIcmpCode(byte icmpCode)
ICMP	setIcmpType(byte icmpType)

Methods inherited from class org.onlab.packet.BasePacket

clone, getParent, getPayload, resetChecksum, setParent, setPayload

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

icmpType

protected byte icmpType

icmpCode

protected byte icmpCode

checksum

protected short checksum

TYPE_ECHO_REQUEST

public static final byte TYPE_ECHO_REQUEST

See Also:

Constant Field Values

TYPE_ECHO_REPLY

public static final byte TYPE_ECHO_REPLY

See Also:

Constant Field Values

SUBTYPE_ECHO_REPLY

public static final byte SUBTYPE_ECHO_REPLY

See Also:

Constant Field Values

ICMP_HEADER_LENGTH

public static final short ICMP_HEADER_LENGTH

See Also:

Constant Field Values

Constructor Detail

ICMP

public ICMP()

Method Detail

getIcmpType

public byte getIcmpType()

Returns:

the icmpType

setIcmpType

public ICMP setIcmpType(byte icmpType)

Parameters:

icmpType - to set

Returns:

this

getIcmpCode

public byte getIcmpCode()

Returns:

the icmp code

setIcmpCode

public ICMP setIcmpCode(byte icmpCode)

Parameters:

icmpCode - code to set

Returns:

this

getChecksum

public short getChecksum()

Returns:

the checksum

setChecksum

public ICMP setChecksum(short checksum)

Parameters:

checksum - the checksum to set

Returns:

this

serialize

public byte[] serialize()

Serializes the packet. Will compute and set the following fields if they are set to specific values at the time serialize is called: -checksum : 0 -length : 0

Returns:

a byte[] containing this packet and payloads

deserialize

public IPacket deserialize(byte[] data,
                           int offset,
                           int length)

Description copied from interface: IPacket

Deserializes this packet layer and all possible payloads. NOTE: This method has been deprecated and will be removed in a future release. It is now recommended to use the Deserializer function provided by the deserialize() method on each packet to deserialize them. The Deserializer functions are robust to malformed input.

Parameters:

data - bytes to deserialize

offset - offset to start deserializing from

length - length of the data to deserialize

Returns:

the deserialized data

hashCode

public int hashCode()

Overrides:

hashCode in class BasePacket

equals

public boolean equals(Object obj)

Overrides:

equals in class BasePacket

deserializer

public static Deserializer<ICMP> deserializer()

Deserializer function for ICMP packets.

Returns:

deserializer function