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

Class Inet4Packet

java.lang.Object

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

All Implemented Interfaces:

Cloneable, CachedPacket, InetHeader, ProtocolHeader

public final class Inet4Packet
extends Object
implements CachedPacket, InetHeader

Inet4Packet class implements a cache for an IPv4 instance.

Constructor Summary

Constructors

Constructor and Description
Inet4Packet(IPv4 ipv4) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
Inet4Packet	clone() Return a deep copy of this instance.
boolean	commit(CachedPacketContext pctx) Finalize modification to the packet.
VTNInet4Match	createMatch(Set<FlowMatchType> fields) Construct match fields to test IP header in this packet.
Ip4Network	getDestinationAddress() Return the destination IP address.
short	getDscp() Return the DSCP field value.
byte[]	getHeaderForChecksum(byte proto, short len) Create a pseudo IPv4 header used for computing TCP/UDP checksum.
IPv4	getPacket() Return an IPv4 instance configured in this instance.
short	getProtocol() Return the IP protocol number.
Ip4Network	getSourceAddress() Return the source IP address.
boolean	isAddressModified() Determine whether the source or destination address is modified or not.
void	setDescription(StringBuilder builder) Set a brief description into the given string builder.
boolean	setDestinationAddress(IpNetwork ipn) Set the destination IP address.
void	setDscp(short dscp) Set the DSCP field value.
boolean	setSourceAddress(IpNetwork ipn) Set the source IP address.

Methods inherited from class java.lang.Object

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

Constructor Detail

Inet4Packet

public Inet4Packet(IPv4 ipv4)

Construct a new instance.

Parameters:

ipv4 - An IPv4 instance.

Method Detail

isAddressModified

public boolean isAddressModified()

Determine whether the source or destination address is modified or not.

Returns:

true only if the source or destination address is modified.

getHeaderForChecksum

public byte[] getHeaderForChecksum(byte proto,
                                   short len)

Create a pseudo IPv4 header used for computing TCP/UDP checksum.

Parameters:

proto - An IP protocol number.

len - The number of octets in a payload.

Returns:

A byte array which represents the pseudo IPv4 header.

createMatch

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

Construct match fields to test IP header in this packet.

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

Parameters:

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

Returns:

A VTNInet4Match instance.

Throws:

RpcException - This packet is broken.

getPacket

public IPv4 getPacket()

Return an IPv4 instance configured in this instance.

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

Specified by:

getPacket in interface CachedPacket

Returns:

An IPv4 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 Inet4Packet clone()

Return a deep copy of this instance.

Specified by:

clone in interface CachedPacket

Overrides:

clone in class Object

Returns:

A deep copy of this instance.

getSourceAddress

public Ip4Network getSourceAddress()

Return the source IP address.

Specified by:

getSourceAddress in interface InetHeader

Returns:

An IpNetwork instance which represents the source IP address.

setSourceAddress

public boolean setSourceAddress(IpNetwork ipn)

Set the source IP address.

Specified by:

setSourceAddress in interface InetHeader

Parameters:

ipn - An IpNetwork instance which represents the source IP address.

Returns:

true if the given address has been successfully set. false if the given address has been rejected.

getDestinationAddress

public Ip4Network getDestinationAddress()

Return the destination IP address.

Specified by:

getDestinationAddress in interface InetHeader

Returns:

An IpNetwork instance which represents the destination IP address.

setDestinationAddress

public boolean setDestinationAddress(IpNetwork ipn)

Set the destination IP address.

Specified by:

setDestinationAddress in interface InetHeader

Parameters:

ipn - An IpNetwork instance which represents the destination IP address.

Returns:

true if the given address has been successfully set. false if the given address has been rejected.

getProtocol

public short getProtocol()

Return the IP protocol number.

Specified by:

getProtocol in interface InetHeader

Returns:

A short integer value which indicates the IP protocol number.

getDscp

public short getDscp()

Return the DSCP field value.

Specified by:

getDscp in interface InetHeader

Returns:

A short value which indicates the DSCP field value.

setDscp

public void setDscp(short dscp)

Set the DSCP field value.

Specified by:

setDscp in interface InetHeader

Parameters:

dscp - A short value which indicates the DSCP field value.

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.