org.opendaylight.vtn.manager.internal.packet.cache

Class IcmpPacket

java.lang.Object

org.opendaylight.vtn.manager.internal.packet.cache.IcmpPacket

All Implemented Interfaces:

Cloneable, CachedPacket, L4Packet, IcmpHeader, Layer4Header, ProtocolHeader

public final class IcmpPacket
extends Object
implements L4Packet, IcmpHeader

IcmpPacket class implements a cache for an ICMP instance.

Constructor Summary

Constructors

Constructor and Description
IcmpPacket(ICMP icmp) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
IcmpPacket	clone() Return a deep copy of this instance.
boolean	commit(CachedPacketContext pctx) Finalize modification to the packet.
VTNIcmpMatch	createMatch(Set<FlowMatchType> fields) Construct match fields to test layer 4 protocol header in this packet.
short	getIcmpCode() Return the ICMP code.
short	getIcmpType() Return the ICMP type.
ICMP	getPacket() Return a ICMP instance configured in this instance.
void	setDescription(StringBuilder builder) Set a brief description into the given string builder.
void	setIcmpCode(short code) Set the ICMP code.
void	setIcmpType(short type) Set the ICMP type.
boolean	updateChecksum(Inet4Packet ipv4) Calculate the checksum of the packet.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IcmpPacket

public IcmpPacket(ICMP icmp)

Construct a new instance.

Parameters:

icmp - An ICMP instance.

Method Detail

getPacket

public ICMP getPacket()

Return a ICMP instance configured in this instance.

Note that modification to the ICMP header is not applied to the returned until commit(CachedPacketContext) is called.

Specified by:

getPacket in interface CachedPacket

Returns:

A ICMP instance.

commit

public boolean commit(CachedPacketContext pctx)
               throws VTNException

Finalize modification to the packet.

Specified by:

commit in interface CachedPacket

Parameters:

pctx - The runtime context for modifying packet.

Returns:

true only if this packet is modified.

Throws:

VTNException - Failed to copy the packet.

clone

public IcmpPacket clone()

Return a deep copy of this instance.

Specified by:

clone in interface CachedPacket

Specified by:

clone in interface L4Packet

Overrides:

clone in class Object

Returns:

A deep copy of this instance.

createMatch

public VTNIcmpMatch createMatch(Set<FlowMatchType> fields)
                         throws RpcException

Construct match fields to test layer 4 protocol header in this packet.

Note that this method creates match fields that matches the original packet. Any modification to the packet is ignored.

Specified by:

createMatch in interface L4Packet

Parameters:

fields - A set of FlowMatchType instances corresponding to match fields to be tested.

Returns:

A VTNLayer4Match instance.

Throws:

RpcException - This packet is broken.

updateChecksum

public boolean updateChecksum(Inet4Packet ipv4)

Calculate the checksum of the packet.

This method does nothing because the ICMP checksum is computed by ICMP class.

Specified by:

updateChecksum in interface L4Packet

Parameters:

ipv4 - Never used.

Returns:

false.

getIcmpType

public short getIcmpType()

Return the ICMP type.

Specified by:

getIcmpType in interface IcmpHeader

Returns:

A short integer value which indicates the ICMP type.

setIcmpType

public void setIcmpType(short type)

Set the ICMP type.

Specified by:

setIcmpType in interface IcmpHeader

Parameters:

type - A short integer value which indicates the ICMP type.

getIcmpCode

public short getIcmpCode()

Return the ICMP code.

Specified by:

getIcmpCode in interface IcmpHeader

Returns:

A short integer value which indicates the ICMP code.

setIcmpCode

public void setIcmpCode(short code)

Set the ICMP code.

Specified by:

setIcmpCode in interface IcmpHeader

Parameters:

code - A short integer value which indicates the ICMP code.

setDescription

public void setDescription(StringBuilder builder)

Set a brief description into the given string builder.

Specified by:

setDescription in interface ProtocolHeader

Parameters:

builder - A StringBuilder instance.