org.opendaylight.vtn.manager.packet

Class ICMP

java.lang.Object

org.opendaylight.vtn.manager.packet.Packet

org.opendaylight.vtn.manager.packet.ICMP

All Implemented Interfaces:

Cloneable

public final class ICMP
extends Packet

ICMP describes an ICMP packet.

This class is provided only for VTN internal use. This class may be changed without any notice.

Since:

Beryllium

Nested Class Summary

Nested classes/interfaces inherited from class org.opendaylight.vtn.manager.packet.Packet

Packet.HeaderField

Constructor Summary

Constructors

Constructor and Description
ICMP()

Method Summary

Methods

Modifier and Type	Method and Description
ICMP	clone() Return a deep copy of this packet.
short	getChecksum() Return the ICMP checksum in this packet.
byte	getCode() Gets the ICMP code (type subtype) for the current ICMP object instance.
protected Map<String,Packet.HeaderField>	getHeaderFormat() Return a map that determines the format of the packet.
int	getHeaderSize() Gets the header size in bits.
short	getIdentifier() Gets the ICMP identifier of the current ICMP object instance.
short	getSequenceNumber() Gets the ICMP sequence number of the current ICMP object instance.
byte	getType() Returns the type field of the current ICMP packet.
protected void	postDeserializeCustomOperation(byte[] data, int offset) This method re-computes the checksum of the bits received on the wire and validates it with the checksum in the bits received.
protected void	postSerializeCustomOperation(byte[] myBytes) This method gets called at the end of the serialization process.
ICMP	setChecksum(short cksum) Sets the ICMP checksum for the current ICMP object instance.
ICMP	setCode(byte code) Sets the ICMP code (type subtype) for the current ICMP object instance.
ICMP	setIdentifier(short id) Sets the ICMP identifier for the current ICMP object instance.
ICMP	setSequenceNumber(short seq) Sets the ICMP sequence number for the current ICMP object instance.
ICMP	setType(byte type) Sets the type for the current ICMP message.

Methods inherited from class org.opendaylight.vtn.manager.packet.Packet

deserialize, equals, equalsField, getByte, getBytes, getFieldNumBits, getFieldNumBits, getFieldOffset, getFieldOffset, getHeaderFieldMap, getInt, getIp4Network, getPayload, getRawPayload, getRawPayloadSize, getShort, hashCode, isCorrupted, isZeroShort, serialize, setCorrupted, setHeaderField, setPayload, setPayloadClass, setRawPayload, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ICMP

public ICMP()

Method Detail

setType

public ICMP setType(byte type)

Sets the type for the current ICMP message.

Parameters:

type - The ICMP message type

Returns:

This ICMP object

getType

public byte getType()

Returns the type field of the current ICMP packet.

Returns:

The type code of the current ICMP packet

setCode

public ICMP setCode(byte code)

Sets the ICMP code (type subtype) for the current ICMP object instance.

Parameters:

code - The ICMP message type subtype

Returns:

This ICMP object

getCode

public byte getCode()

Gets the ICMP code (type subtype) for the current ICMP object instance.

Returns:

The ICMP message type subtype

setChecksum

public ICMP setChecksum(short cksum)

Sets the ICMP checksum for the current ICMP object instance.

Parameters:

cksum - The checksum value to be set.

Returns:

This instance.

getChecksum

public short getChecksum()

Return the ICMP checksum in this packet.

Returns:

The ICMP checksum value.

setIdentifier

public ICMP setIdentifier(short id)

Sets the ICMP identifier for the current ICMP object instance.

Parameters:

id - The ICMP identifier to be set.

Returns:

This instance.

getIdentifier

public short getIdentifier()

Gets the ICMP identifier of the current ICMP object instance.

Returns:

The ICMP identifier.

setSequenceNumber

public ICMP setSequenceNumber(short seq)

Sets the ICMP sequence number for the current ICMP object instance.

Parameters:

seq - The ICMP sequence number to be set.

Returns:

This instance.

getSequenceNumber

public short getSequenceNumber()

Gets the ICMP sequence number of the current ICMP object instance.

Returns:

The ICMP sequence number.

getHeaderSize

public int getHeaderSize()

Gets the header size in bits.

Overrides:

getHeaderSize in class Packet

Returns:

The ICMP header size in bits.

getHeaderFormat

protected Map<String,Packet.HeaderField> getHeaderFormat()

Return a map that determines the format of the packet.

Specified by:

getHeaderFormat in class Packet

Returns:

A map that determines the format of the packet.

postSerializeCustomOperation

protected void postSerializeCustomOperation(byte[] myBytes)
                                     throws PacketException

This method gets called at the end of the serialization process. It is intended for the child packets to insert some custom data into the output byte stream which cannot be done or cannot be done efficiently during the normal Packet.serialize() path. An example is the checksum computation for IPv4.

Overrides:

postSerializeCustomOperation in class Packet

Parameters:

myBytes - Serialized bytes.

Throws:

PacketException - An error occurred.

postDeserializeCustomOperation

protected void postDeserializeCustomOperation(byte[] data,
                                  int offset)

This method re-computes the checksum of the bits received on the wire and validates it with the checksum in the bits received. Since the computation of checksum varies based on the protocol, this method is overridden. Currently only IPv4 and ICMP do checksum computation and validation. TCP and UDP need to implement these if required.

Overrides:

postDeserializeCustomOperation in class Packet

Parameters:

data - The byte stream representing the Ethernet frame.

offset - The bit offset from where the byte array corresponding to this Packet starts in the frame

clone

public ICMP clone()

Return a deep copy of this packet.

Overrides:

clone in class Packet

Returns:

A deep copy of this packet.