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

Class PortProtoPacket<T extends PortPacket<T>>

java.lang.Object

org.opendaylight.vtn.manager.internal.packet.cache.PortProtoPacket<T>

Type Parameters:

T - Type of packet.

All Implemented Interfaces:

Cloneable, CachedPacket, L4Packet, Layer4Header, Layer4PortHeader, ProtocolHeader

Direct Known Subclasses:

TcpPacket, UdpPacket

public abstract class PortProtoPacket<T extends PortPacket<T>>
extends Object
implements L4Packet, Layer4PortHeader

PortProtoPacket class implements a cache for layer 4 protocol header, which identifies the service using 16-bit port number.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PortProtoPacket(T pkt) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
PortProtoPacket<T>	clone() Return a deep copy of this instance.
boolean	commit(CachedPacketContext pctx) Finalize modification to the packet.
protected static short	computeChecksum(Inet4Packet ipv4, PortPacket<?> packet, int sumOff) Compute the checksum of the given packet.
VTNLayer4PortMatch	createMatch(Set<FlowMatchType> fields) Construct match fields to test layer 4 protocol header in this packet.
protected abstract VTNLayer4PortMatch	createMatch(VTNPortRange src, VTNPortRange dst) Construct flow match fields.
abstract FlowMatchType	getDestinationMatchType() Return a flow match type corresponding to the destination port.
int	getDestinationPort() Return the destination port number.
T	getPacket() Return a Packet instance.
protected T	getPacketForWrite() Return a PortPacket instance to set modified values.
abstract FlowMatchType	getSourceMatchType() Return a flow match type corresponding to the source port.
int	getSourcePort() Return the source port number.
void	setDescription(StringBuilder builder) Set a brief description into the given string builder.
void	setDestinationPort(int port) Set the destination port number.
void	setSourcePort(int port) Set the source port number.
protected static boolean	verifyChecksum(Inet4Packet ipv4, PortPacket<?> packet) Verify the packet using the checksum.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opendaylight.vtn.manager.internal.packet.cache.L4Packet

updateChecksum

Constructor Detail

PortProtoPacket

protected PortProtoPacket(T pkt)

Construct a new instance.

Parameters:

pkt - A raw packet instance.

Method Detail

computeChecksum

protected static final short computeChecksum(Inet4Packet ipv4,
                                             PortPacket<?> packet,
                                             int sumOff)
                                      throws VTNException

Compute the checksum of the given packet.

Parameters:

ipv4 - An Inet4Packet instance that contains the given packet.

packet - A PortPacket instance.

sumOff - Offset in bytes to the checksum field.

Returns:

A computed checksum.

Throws:

VTNException - An error occurred.

verifyChecksum

protected static final boolean verifyChecksum(Inet4Packet ipv4,
                                              PortPacket<?> packet)
                                       throws VTNException

Verify the packet using the checksum.

Parameters:

ipv4 - An Inet4Packet instance that contains the given packet.

packet - A PortPacket to be verified.

Returns:

true is returned only if the verification succeeded.

Throws:

VTNException - An error occurred.

getPacketForWrite

protected final T getPacketForWrite()

Return a PortPacket instance to set modified values.

Returns:

A PortPacket instance.

createMatch

protected abstract VTNLayer4PortMatch createMatch(VTNPortRange src,
                                                  VTNPortRange dst)
                                           throws RpcException

Construct flow match fields.

Parameters:

src - A VTNPortRange instance which specifies the source port.

dst - A VTNPortRange instance which specifies the destination port.

Returns:

A VTNLayer4PortMatch instance.

Throws:

RpcException - Invalid value is specified.

getSourceMatchType

public abstract FlowMatchType getSourceMatchType()

Return a flow match type corresponding to the source port.

Returns:

A FlowMatchType instance.

getDestinationMatchType

public abstract FlowMatchType getDestinationMatchType()

Return a flow match type corresponding to the destination port.

Returns:

A FlowMatchType instance.

getPacket

public final T getPacket()

Return a Packet instance.

Note that modification to this instance is not applied to the returned packet until CachedPacket.commit(CachedPacketContext) is called.

Specified by:

getPacket in interface CachedPacket

Returns:

A Packet instance.

commit

public final 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 final PortProtoPacket<T> 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 final VTNLayer4PortMatch 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.

getSourcePort

public final int getSourcePort()

Return the source port number.

Specified by:

getSourcePort in interface Layer4PortHeader

Returns:

An integer value which represents the source port number.

setSourcePort

public final void setSourcePort(int port)

Set the source port number.

Specified by:

setSourcePort in interface Layer4PortHeader

Parameters:

port - An integer value which represents the source port number.

getDestinationPort

public final int getDestinationPort()

Return the destination port number.

Specified by:

getDestinationPort in interface Layer4PortHeader

Returns:

An integer value which represents the destination port number.

setDestinationPort

public final void setDestinationPort(int port)

Set the destination port number.

Specified by:

setDestinationPort in interface Layer4PortHeader

Parameters:

port - An integer value which represents the destination port number.

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.