org.opendaylight.vtn.manager.packet

Class Ethernet

java.lang.Object

org.opendaylight.vtn.manager.packet.Packet

org.opendaylight.vtn.manager.packet.Ethernet

All Implemented Interfaces:

Cloneable

public class Ethernet
extends Packet

Ethernet describes an Ethernet frame.

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

Method Summary

Methods

Modifier and Type	Method and Description
Ethernet	clone() Return a deep copy of this packet.
byte[]	getDestinationMACAddress() Gets the destination MAC address stored.
short	getEtherType() Gets the etherType stored.
protected Map<String,Packet.HeaderField>	getHeaderFormat() Return a map that determines the format of the packet.
int	getHeaderSize() Return the number of bits in the Ethernet header.
byte[]	getSourceMACAddress() Gets the source MAC address stored.
Ethernet	setDestinationMACAddress(byte[] mac) Sets the destination MAC address for the current Ethernet object.
Ethernet	setEtherType(short type) Sets the etherType for the current Ethernet object.
protected void	setHeaderField(String name, byte[] value) Stores the value of fields read from data stream.
Ethernet	setSourceMACAddress(byte[] mac) Sets the source MAC address for the current Ethernet object.

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

Ethernet

public Ethernet()

Method Detail

getDestinationMACAddress

public byte[] getDestinationMACAddress()

Gets the destination MAC address stored.

Returns:

The destination MAC address. null if not configured.

getSourceMACAddress

public byte[] getSourceMACAddress()

Gets the source MAC address stored.

Returns:

The source MAC address. null if not configured.

getEtherType

public short getEtherType()

Gets the etherType stored.

Returns:

The Ethernet type.

setDestinationMACAddress

public Ethernet setDestinationMACAddress(byte[] mac)

Sets the destination MAC address for the current Ethernet object.

Parameters:

mac - The destination MAC address. null cannot be specified.

Returns:

This instance.

setSourceMACAddress

public Ethernet setSourceMACAddress(byte[] mac)

Sets the source MAC address for the current Ethernet object.

Parameters:

mac - The source MAC address. null cannot be specified.

Returns:

This instance.

setEtherType

public Ethernet setEtherType(short type)

Sets the etherType for the current Ethernet object.

Parameters:

type - The Ethernet type.

Returns:

This instance.

getHeaderSize

public int getHeaderSize()

Return the number of bits in the Ethernet header.

Overrides:

getHeaderSize in class Packet

Returns:

The number of bits in the Ethernet header.

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

Return a deep copy of this packet.

Overrides:

clone in class Packet

Returns:

A deep copy of this packet.