org.opendaylight.vtn.manager.packet

Class IEEE8021Q

java.lang.Object

org.opendaylight.vtn.manager.packet.Packet

org.opendaylight.vtn.manager.packet.IEEE8021Q

All Implemented Interfaces:

Cloneable

public final class IEEE8021Q
extends Packet

IEEE8021Q describes an IEEE 802.1Q VLAN tag.

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
IEEE8021Q()

Method Summary

Methods

Modifier and Type	Method and Description
IEEE8021Q	clone() Return a deep copy of this packet.
byte	getCfi() Gets the canonical format indicator(CFI) stored.
short	getEtherType() Gets the Ethernet type stored.
protected Map<String,Packet.HeaderField>	getHeaderFormat() Return a map that determines the format of the packet.
int	getHeaderSize() Gets the header size in bits.
byte	getPcp() Gets the priority code point(PCP) stored.
short	getVid() Gets the VLAN identifier(VID) stored.
IEEE8021Q	setCfi(byte cfi) Sets the canonical format indicator(CFI) for the current IEEE 802.1Q object instance.
IEEE8021Q	setEtherType(short type) Sets the etherType for the current IEEE 802.1Q object instance.
protected void	setHeaderField(String name, byte[] value) Stores the value of fields read from data stream.
IEEE8021Q	setPcp(byte pcp) Sets the priority code point(PCP) for the current IEEE 802.1Q object instance.
IEEE8021Q	setVid(short vid) Sets the VLAN identifier(VID) for the current IEEE 802.1Q instance.

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, postDeserializeCustomOperation, postSerializeCustomOperation, serialize, setCorrupted, setPayload, setPayloadClass, setRawPayload, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

IEEE8021Q

public IEEE8021Q()

Method Detail

getPcp

public byte getPcp()

Gets the priority code point(PCP) stored.

Returns:

The priority code point value.

getCfi

public byte getCfi()

Gets the canonical format indicator(CFI) stored.

Returns:

The canonical format indicator value.

getVid

public short getVid()

Gets the VLAN identifier(VID) stored.

Returns:

The VLAN ID.

getEtherType

public short getEtherType()

Gets the Ethernet type stored.

Returns:

The Ethernet type.

setPcp

public IEEE8021Q setPcp(byte pcp)

Sets the priority code point(PCP) for the current IEEE 802.1Q object instance.

Parameters:

pcp - The priority code point value.

Returns:

This instance.

setCfi

public IEEE8021Q setCfi(byte cfi)

Sets the canonical format indicator(CFI) for the current IEEE 802.1Q object instance.

Parameters:

cfi - The canonical format indicator value.

Returns:

This instance.

setVid

public IEEE8021Q setVid(short vid)

Sets the VLAN identifier(VID) for the current IEEE 802.1Q instance.

Parameters:

vid - The VLAN ID.

Returns:

This instance.

setEtherType

public IEEE8021Q setEtherType(short type)

Sets the etherType for the current IEEE 802.1Q object instance.

Parameters:

type - The Ethernet type.

Returns:

This instance.

getHeaderSize

public int getHeaderSize()

Gets the header size in bits.

Overrides:

getHeaderSize in class Packet

Returns:

The IEEE 802.1Q 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.

setHeaderField

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

Stores the value of fields read from data stream.

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.

clone

public IEEE8021Q clone()

Return a deep copy of this packet.

Overrides:

clone in class Packet

Returns:

A deep copy of this packet.