org.opendaylight.vtn.manager.packet

Class IPv4

java.lang.Object

org.opendaylight.vtn.manager.packet.Packet

org.opendaylight.vtn.manager.packet.IPv4

All Implemented Interfaces:

Cloneable

public final class IPv4
extends Packet

IPv4 describes an IP version 4 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

Field Summary

Fields

Modifier and Type	Field and Description
static int	CKSUM_BYTES The number of octets in IP checksum.
static byte	IPV4_VERSION The IPv4 version number.

Constructor Summary

Constructors

Constructor and Description
IPv4() Construct a new instance.

Method Summary

Modifier and Type	Method and Description
IPv4	clone() Return a deep copy of this packet.
protected boolean	equalsField(String name, byte[] value1, byte[] value2) Compare the given header field values.
short	getChecksum() Gets the checksum value stored.
Ip4Network	getDestinationAddress() Gets the destination IP address stored.
byte	getDiffServ() Gets the differential services value stored.
byte	getECN() Gets the ECN bits stored.
protected int	getFieldNumBits(String name, Packet.HeaderField entry) Gets the number of bits for the specified field.
byte	getFlags() Gets the flag values stored.
short	getFragmentOffset() Gets the fragment offset stored.
protected Map<String,Packet.HeaderField>	getHeaderFormat() Return a map that determines the format of the packet.
int	getHeaderLen() Gets the IP header length stored.
int	getHeaderSize() Gets the header size in bits.
short	getIdentification() Gets the identification value stored.
byte[]	getOptions() Gets the Options stored.
byte	getProtocol() Gets the protocol value stored.
Ip4Network	getSourceAddress() Gets the source IP address stored.
short	getTotalLength() Gets the total length of the IPv4 packe in bytes.
byte	getTtl() Gets the TTL value stored.
byte	getVersion() Gets the IP version stored.
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.
IPv4	setChecksum(short cksum) Set the IP checksum value.
IPv4	setDestinationAddress(Ip4Network addr) Stores the IP destination address from the header.
IPv4	setDiffServ(byte dserv) Stores the differential services value from the IP header.
IPv4	setECN(byte ecn) Stores the ECN bits from the header.
IPv4	setFlags(byte flags) Stores the IP flags value.
IPv4	setFragmentOffset(short off) Stores the IP fragmentation offset value.
protected void	setHeaderField(String name, byte[] value) Stores the value of fields read from data stream.
IPv4	setHeaderLength(byte len) Stores the length of IP header in words (4 bytes).
IPv4	setIdentification(short id) Stores the identification number from the header.
IPv4	setOptions(byte[] options) Store the options from IP header.
void	setPayload(Packet p) Set the packet encapsulated by this IPv4 packet.
IPv4	setProtocol(byte proto) Stores the protocol value of the IP payload.
IPv4	setSourceAddress(Ip4Network addr) Stores the IP source address from the header.
IPv4	setTotalLength(short len) Stores the total length of IPv4 packet in bytes.
IPv4	setTtl(byte ttl) Stores the TTL value.
IPv4	setVersion(byte version) Stores the IP version from the header.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

IPV4_VERSION

public static final byte IPV4_VERSION

The IPv4 version number.

See Also:

Constant Field Values

CKSUM_BYTES

public static final int CKSUM_BYTES

The number of octets in IP checksum.

See Also:

Constant Field Values

Constructor Detail

IPv4

public IPv4()

Construct a new instance.

This constructor sets the version to 4, headerLength to 5, and flags to 2.

Method Detail

getVersion

public byte getVersion()

Gets the IP version stored.

Returns:

The IP version.

getHeaderLen

public int getHeaderLen()

Gets the IP header length stored.

Returns:

The IP header length in bytes.

getDiffServ

public byte getDiffServ()

Gets the differential services value stored.

Returns:

The differential services value.

getECN

public byte getECN()

Gets the ECN bits stored.

Returns:

The ECN bits.

getTotalLength

public short getTotalLength()

Gets the total length of the IPv4 packe in bytes.

Returns:

The total length of the IPv4 packet.

getIdentification

public short getIdentification()

Gets the identification value stored.

Returns:

The IP identification value.

getFlags

public byte getFlags()

Gets the flag values stored.

Returns:

The IPv4 flags.

getTtl

public byte getTtl()

Gets the TTL value stored.

Returns:

The TTL value.

getProtocol

public byte getProtocol()

Gets the protocol value stored.

Returns:

The IP protocol number.

getChecksum

public short getChecksum()

Gets the checksum value stored.

Returns:

The IP header checksum.

getFragmentOffset

public short getFragmentOffset()

Gets the fragment offset stored.

Returns:

The IP fragment offset.

getSourceAddress

public Ip4Network getSourceAddress()

Gets the source IP address stored.

Returns:

An Ip4Network instance that represents the source IP address.

getDestinationAddress

public Ip4Network getDestinationAddress()

Gets the destination IP address stored.

Returns:

An Ip4Network instance that represents the destination IP address.

getOptions

public byte[] getOptions()

Gets the Options stored.

Returns:

The IPv4 options. null if no option is present.

setVersion

public IPv4 setVersion(byte version)

Stores the IP version from the header.

Parameters:

version - The version to set

Returns:

This instance.

setHeaderLength

public IPv4 setHeaderLength(byte len)

Stores the length of IP header in words (4 bytes).

Parameters:

len - The headerLength to set.

Returns:

This instance.

setDiffServ

public IPv4 setDiffServ(byte dserv)

Stores the differential services value from the IP header.

Parameters:

dserv - The differential services value.

Returns:

This instance.

setECN

public IPv4 setECN(byte ecn)

Stores the ECN bits from the header.

Parameters:

ecn - The ECN bits to set.

Returns:

This instance.

setTotalLength

public IPv4 setTotalLength(short len)

Stores the total length of IPv4 packet in bytes.

Parameters:

len - The total length of the IPv4 packet.

Returns:

This instance.

setIdentification

public IPv4 setIdentification(short id)

Stores the identification number from the header.

Parameters:

id - The identification to set.

Returns:

This instance.

setFlags

public IPv4 setFlags(byte flags)

Stores the IP flags value.

Parameters:

flags - The flags to set.

Returns:

This instance.

setFragmentOffset

public IPv4 setFragmentOffset(short off)

Stores the IP fragmentation offset value.

Parameters:

off - The fragmentation offset.

Returns:

This instance.

setTtl

public IPv4 setTtl(byte ttl)

Stores the TTL value.

Parameters:

ttl - The ttl to set.

Returns:

This instance.

setProtocol

public IPv4 setProtocol(byte proto)

Stores the protocol value of the IP payload.

Parameters:

proto - The protocol to set.

Returns:

This instance.

setChecksum

public IPv4 setChecksum(short cksum)

Set the IP checksum value.

This method is only for testing. IP checksum will be updated on serialization.

Parameters:

cksum - The IP checksum.

Returns:

This instance.

setSourceAddress

public IPv4 setSourceAddress(Ip4Network addr)

Stores the IP source address from the header.

The network prefix in the given paramter is always ignored.

Parameters:

addr - The source IP address.

Returns:

This instance.

setDestinationAddress

public IPv4 setDestinationAddress(Ip4Network addr)

Stores the IP destination address from the header.

The network prefix in the given paramter is always ignored.

Parameters:

addr - The destination IP address.

Returns:

This instance.

setOptions

public IPv4 setOptions(byte[] options)

Store the options from IP header.

Parameters:

options - The IP options.

Returns:

This instance.

getHeaderSize

public int getHeaderSize()

Gets the header size in bits.

Overrides:

getHeaderSize in class Packet

Returns:

The number of bits constituting the header.

getFieldNumBits

protected int getFieldNumBits(String name,
                              Packet.HeaderField entry)

Gets the number of bits for the specified field.

If the fieldname has variable length like "Options", then this value is computed using the header length.

Overrides:

getFieldNumBits in class Packet

Parameters:

name - The name of the header field.

entry - The header field entry associated with name.

Returns:

The number of bits of the requested field.

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.

setHeaderField

protected void setHeaderField(String name,
                              byte[] value)

Stores the value of fields read from data stream.

Variable header value like payload protocol, is stored here.

Overrides:

setHeaderField in class Packet

Parameters:

name - The name of the header field.

value - The value to be associated with the specified header field. null cannot be specified.

equalsField

protected boolean equalsField(String name,
                              byte[] value1,
                              byte[] value2)

Compare the given header field values.

Overrides:

equalsField in class Packet

Parameters:

name - The name of the header field.

value1 - The first header field value to be compared.

value2 - The second header field value to be compared.

Returns:

true only if the given two header field values are identical.

setPayload

public void setPayload(Packet p)

Set the packet encapsulated by this IPv4 packet.

This method updates the total length of the IPv4 packet.

Overrides:

setPayload in class Packet

Parameters:

p - The packet encapsulated by this IPv4 packet.

postSerializeCustomOperation

protected void postSerializeCustomOperation(byte[] myBytes)
                                     throws PacketException

This method gets called at the end of the serialization process.

This method computes the IP checksum and stores it into the IP header.

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.

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

Return a deep copy of this packet.

Overrides:

clone in class Packet

Returns:

A deep copy of this packet.