org.projectfloodlight.openflow.types

Class OFGroup

java.lang.Object

org.projectfloodlight.openflow.types.OFGroup

All Implemented Interfaces:

Comparable<OFGroup>, OFValueType<OFGroup>, PrimitiveSinkable

public class OFGroup
extends Object
implements OFValueType<OFGroup>

Abstraction of an logical / OpenFlow group (ofp_group) in OpenFlow. Immutable.

Author:

Andreas Wundsam <andreas.wundsam@bigswitch.com>

Field Summary

Fields

Modifier and Type	Field and Description
static OFGroup	ALL All groups
static OFGroup	ANY Wildcard group used only for flow mod (delete) and flow stats requests.
static OFGroup	FULL_MASK
static OFGroup	MAX Maximum number of physical and logical switch groups.
static OFGroup	NO_MASK
static OFGroup	ZERO group 0 in case we need it

Method Summary

Modifier and Type	Method and Description
OFGroup	applyMask(OFGroup mask)
int	compareTo(OFGroup o)
boolean	equals(Object obj)
int	getGroupNumber() get the group number of this group as a int32
int	getLength()
int	hashCode()
static OFGroup	of(int groupNumber) get an OFGroup object corresponding to a raw 32-bit integer group number.
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 OFGroup	read4Bytes(io.netty.buffer.ByteBuf c)
String	toString()
void	write4Bytes(io.netty.buffer.ByteBuf c)

Methods inherited from class java.lang.Object

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

Field Detail

MAX

public static final OFGroup MAX

Maximum number of physical and logical switch groups.

ALL

public static final OFGroup ALL

All groups

ANY

public static final OFGroup ANY

Wildcard group used only for flow mod (delete) and flow stats requests.

ZERO

public static final OFGroup ZERO

group 0 in case we need it

NO_MASK

public static final OFGroup NO_MASK

FULL_MASK

public static final OFGroup FULL_MASK

Method Detail

of

public static OFGroup of(int groupNumber)

get an OFGroup object corresponding to a raw 32-bit integer group number. NOTE: The group object may either be newly allocated or cached. Do not rely on either behavior.

Parameters:

groupNumber - the raw 32-bit group number

Returns:

a corresponding OFPort

getGroupNumber

public int getGroupNumber()

get the group number of this group as a int32

Returns:

the integer form of the this group

toString

public String toString()

Overrides:

toString in class Object

getLength

public int getLength()

Specified by:

getLength in interface OFValueType<OFGroup>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

write4Bytes

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

read4Bytes

public static OFGroup read4Bytes(io.netty.buffer.ByteBuf c)
                          throws OFParseError

Throws:

OFParseError

applyMask

public OFGroup applyMask(OFGroup mask)

Specified by:

applyMask in interface OFValueType<OFGroup>

compareTo

public int compareTo(OFGroup o)

Specified by:

compareTo in interface Comparable<OFGroup>

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.