org.projectfloodlight.openflow.types

Class MacAddress

java.lang.Object

org.projectfloodlight.openflow.types.MacAddress

All Implemented Interfaces:

Comparable<MacAddress>, OFValueType<MacAddress>, PrimitiveSinkable

public class MacAddress
extends Object
implements OFValueType<MacAddress>

Wrapper around a 6 byte mac address.

Author:

Andreas Wundsam <andreas.wundsam@bigswitch.com>

Field Summary

Fields

Modifier and Type	Field and Description
static MacAddress	BROADCAST
static MacAddress	FULL_MASK
static MacAddress	NO_MASK
static MacAddress	NONE

Method Summary

Methods

Modifier and Type	Method and Description
MacAddress	applyMask(MacAddress mask)
int	compareTo(MacAddress o)
boolean	equals(Object obj)
static MacAddress	forIPv4MulticastAddress(IPv4Address ipv4)
static MacAddress	forIPv6MulticastAddr(IPv6Address ipv6) Generate a MAC address corresponding to multicast IPv6 address.
byte[]	getBytes()
int	getLength()
long	getLong()
int	hashCode()
boolean	isBroadcast() Returns true if the MAC address is the broadcast address.
boolean	isLLDPAddress() Returns true if the MAC address is an LLDP mac address.
boolean	isMulticast() Returns true if the MAC address is a multicast address.
static MacAddress	of(byte[] address)
static MacAddress	of(DatapathId dpid) Creates a MacAddress from a DatapathId.
static MacAddress	of(long raw)
static MacAddress	of(String macString) Parse a mac adress from a string representation as 6 hex bytes separated by colons or hyphens (01:02:03:04:05:06, 01-02-03-04-05-06).
void	putTo(com.google.common.hash.PrimitiveSink sink) Dump the state of this object into a PrimitiveSink (e.g., a Hasher) for the purpose of computing a strong hash.
static MacAddress	read6Bytes(io.netty.buffer.ByteBuf c)
String	toString()
void	write6Bytes(io.netty.buffer.ByteBuf c)

Methods inherited from class java.lang.Object

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

Field Detail

NONE

public static final MacAddress NONE

BROADCAST

public static final MacAddress BROADCAST

NO_MASK

public static final MacAddress NO_MASK

FULL_MASK

public static final MacAddress FULL_MASK

Method Detail

of

public static MacAddress of(byte[] address)

of

public static MacAddress of(long raw)

of

@Nonnull
public static MacAddress of(@Nonnull
                    String macString)
                     throws IllegalArgumentException

Parse a mac adress from a string representation as 6 hex bytes separated by colons or hyphens (01:02:03:04:05:06, 01-02-03-04-05-06).

Parameters:

macString - - a mac address in string representation

Returns:

the parsed MacAddress

Throws:

IllegalArgumentException - if macString is not a valid mac adddress

of

public static MacAddress of(@Nonnull
            DatapathId dpid)

Creates a MacAddress from a DatapathId. This factory method assumes that the first two bytes of the DatapathId are 0 bytes.

Parameters:

dpid - the DatapathId to create the MacAddress from

Returns:

a MacAddress derived from the supplied DatapathId

getBytes

public byte[] getBytes()

isBroadcast

public boolean isBroadcast()

Returns true if the MAC address is the broadcast address.

Returns:

true if the MAC address is the broadcast address.

isMulticast

public boolean isMulticast()

Returns true if the MAC address is a multicast address.

Returns:

true if the MAC address is a multicast address.

isLLDPAddress

public boolean isLLDPAddress()

Returns true if the MAC address is an LLDP mac address.

Returns:

true if the MAC address is an LLDP mac address.

getLength

public int getLength()

Specified by:

getLength in interface OFValueType<MacAddress>

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getLong

public long getLong()

write6Bytes

public void write6Bytes(io.netty.buffer.ByteBuf c)

read6Bytes

public static MacAddress read6Bytes(io.netty.buffer.ByteBuf c)
                             throws OFParseError

Throws:

OFParseError

applyMask

public MacAddress applyMask(MacAddress mask)

Specified by:

applyMask in interface OFValueType<MacAddress>

compareTo

public int compareTo(MacAddress o)

Specified by:

compareTo in interface Comparable<MacAddress>

putTo

public void putTo(com.google.common.hash.PrimitiveSink sink)

Description copied from interface: PrimitiveSinkable

Dump the state of this object into a PrimitiveSink (e.g., a Hasher) for the purpose of computing a strong hash. Equality contract: Equal objects must dump the equal data into the sink, non-equal objects must dump different data into the sink. Please see the interface documentation of PrimitiveSink for more details and caveats/traps.

Specified by:

putTo in interface PrimitiveSinkable

Parameters:

sink - the sink to dump the object state into.

forIPv4MulticastAddress

@Nonnull
public static MacAddress forIPv4MulticastAddress(IPv4Address ipv4)
                                          throws IllegalArgumentException

Throws:

IllegalArgumentException

forIPv6MulticastAddr

@Nonnull
public static MacAddress forIPv6MulticastAddr(IPv6Address ipv6)
                                       throws IllegalArgumentException

Generate a MAC address corresponding to multicast IPv6 address. Take the last 4 bytes of IPv6 address and copy them to the base IPv6 multicast mac address - 33:33:00:00:00:00.

Parameters:

ipv6 - - IPv6 address corresponding to which multicast MAC addr need to be generated.

Returns:

- the generated multicast mac address.

Throws:

IllegalArgumentException - if ipv6 address is not a valid IPv6 multicast address.