org.opendaylight.vtn.manager.internal.util.packet

Interface EtherHeader

All Superinterfaces:

ProtocolHeader

All Known Implementing Classes:

EtherPacket

public interface EtherHeader
extends ProtocolHeader

EtherHeader describes the contents of ethernet header and IEEE 802.1Q VLAN tag.

Field Summary

Fields

Modifier and Type	Field and Description
static int	VLAN_NONE A pseudo VLAN ID that indicates untagged ethernet frame.

Method Summary

Modifier and Type	Method and Description
EtherAddress	getDestinationAddress() Return the destination MAC address.
int	getEtherType() Return the ethernet type.
EtherAddress	getSourceAddress() Return the source MAC address.
int	getVlanId() Return the VLAN ID in the IEEE 802.1Q VLAN tag.
short	getVlanPriority() Return the VLAN priority value in the IEEE 802.1Q VLAN tag.
void	setDestinationAddress(EtherAddress mac) Set the destination MAC address.
void	setSourceAddress(EtherAddress mac) Set the source MAC address.
void	setVlanId(int vid) Set the VLAN ID to the IEEE 802.1Q VLAN tag.
void	setVlanPriority(short pcp) Set the VLAN priority value to the IEEE 802.1Q VLAN tag.

Methods inherited from interface org.opendaylight.vtn.manager.internal.util.packet.ProtocolHeader

setDescription

Field Detail

VLAN_NONE

static final int VLAN_NONE

A pseudo VLAN ID that indicates untagged ethernet frame.

See Also:

Constant Field Values

Method Detail

getSourceAddress

EtherAddress getSourceAddress()

Return the source MAC address.

Returns:

An EtherAddress instance which represents the source MAC address.

setSourceAddress

void setSourceAddress(EtherAddress mac)

Set the source MAC address.

Parameters:

mac - An EtherAddress instance which represents the source MAC address.

getDestinationAddress

EtherAddress getDestinationAddress()

Return the destination MAC address.

Returns:

An EtherAddress instance which represents the destination MAC address.

setDestinationAddress

void setDestinationAddress(EtherAddress mac)

Set the destination MAC address.

Parameters:

mac - An EtherAddress instance which represents the destination MAC address.

getEtherType

int getEtherType()

Return the ethernet type.

Returns:

An integer value which represents the ethernet type.

getVlanId

int getVlanId()

Return the VLAN ID in the IEEE 802.1Q VLAN tag.

Returns:

A VLAN ID in the VLAN tag. VLAN_NONE is returned if this frame does not contain a VLAN tag.

setVlanId

void setVlanId(int vid)

Set the VLAN ID to the IEEE 802.1Q VLAN tag.

Parameters:

vid - A VLAN ID in the VLAN tag. If VLAN_NONE is specified, the VLAN tag will be removed.

getVlanPriority

short getVlanPriority()

Return the VLAN priority value in the IEEE 802.1Q VLAN tag.

Returns:

A byte value which represents the VLAN priority. A negative value is returned if the VLAN priority is not configured in this instance.

setVlanPriority

void setVlanPriority(short pcp)

Set the VLAN priority value to the IEEE 802.1Q VLAN tag.

Parameters:

pcp - A byte value which represents the VLAN priority.