com.hp.of.ctl.prio

Class FlowClassAdapter

java.lang.Object

com.hp.of.ctl.prio.FlowClassAdapter

All Implemented Interfaces:

FlowClass

public class FlowClassAdapter
extends Object
implements FlowClass

An adapter for the FlowClass interface.

Author:

Shaun Wackerly

Nested Class Summary

Nested classes/interfaces inherited from interface com.hp.of.ctl.prio.FlowClass

FlowClass.ActionClass

Field Summary

Fields inherited from interface com.hp.of.ctl.prio.FlowClass

COOKIE_MASK

Constructor Summary

Constructors

Constructor and Description
FlowClassAdapter()

Method Summary

Methods

Modifier and Type	Method and Description
Set<FlowClass.ActionClass>	actions() Returns the set of expected action types.
int	actualPriority() Returns the controller-issued actual priority that will be used when sending flow-mod messages to the switches.
long	baseCookie() Returns the base cookie whose upper 16 bits will be assigned, thus leaving the lower 48 bits free for use by the application.
String	description() Returns the description of purpose and intent behind this class of flows.
Set<String>	higherIds() Returns the set of flow class identifiers whose actual priorities must be above this one.
String	id() Returns the global flow class identifier.
Set<String>	lowerIds() Returns the set of flow class identifiers whose actual priorities must be lower than this one.
Set<OxmFieldType>	matchFields() Returns the set of field types expected to be set in the match.
String	password() Returns the password specified by the application during registration.
int	priority() Returns the controller-issued unique and opaque value that represents the relative priority of this flow class, and which is to be used in lieu of priority.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FlowClassAdapter

public FlowClassAdapter()

Method Detail

priority

public int priority()

Description copied from interface: FlowClass

Returns the controller-issued unique and opaque value that represents the relative priority of this flow class, and which is to be used in lieu of priority.

This accessor is available only on the private instances returned by the FlowClassBroker.register(java.lang.String, java.lang.String, java.lang.String, java.util.Set<java.lang.String>, java.util.Set<java.lang.String>, java.util.Set<com.hp.of.lib.match.OxmFieldType>, java.util.Set<com.hp.of.ctl.prio.FlowClass.ActionClass>) invocation and not on the public ones obtained via FlowClassBroker.getFlowClasses().

Specified by:

priority in interface FlowClass

Returns:

unique and opaque value representing the relative priority

actualPriority

public int actualPriority()

Description copied from interface: FlowClass

Returns the controller-issued actual priority that will be used when sending flow-mod messages to the switches.

This accessor is available only on the private instances returned by the FlowClassBroker.register(java.lang.String, java.lang.String, java.lang.String, java.util.Set<java.lang.String>, java.util.Set<java.lang.String>, java.util.Set<com.hp.of.lib.match.OxmFieldType>, java.util.Set<com.hp.of.ctl.prio.FlowClass.ActionClass>) invocation and not on the public ones obtained via FlowClassBroker.getFlowClasses().

Specified by:

actualPriority in interface FlowClass

Returns:

actual priority value

baseCookie

public long baseCookie()

Description copied from interface: FlowClass

Returns the base cookie whose upper 16 bits will be assigned, thus leaving the lower 48 bits free for use by the application. Flow mods sent on behalf of this flow class should send cookies ORed with this base cookie, leaving the upper 16 bits intact; otherwise the flow mod may get rejected.

Specified by:

baseCookie in interface FlowClass

Returns:

assigned base cookie

id

public String id()

Description copied from interface: FlowClass

Returns the global flow class identifier.

Specified by:

id in interface FlowClass

Returns:

flow class id

password

public String password()

Description copied from interface: FlowClass

Returns the password specified by the application during registration.

Specified by:

password in interface FlowClass

Returns:

password

description

public String description()

Description copied from interface: FlowClass

Returns the description of purpose and intent behind this class of flows.

Specified by:

description in interface FlowClass

Returns:

purpose narrative for this class

lowerIds

public Set<String> lowerIds()

Description copied from interface: FlowClass

Returns the set of flow class identifiers whose actual priorities must be lower than this one.

Specified by:

lowerIds in interface FlowClass

Returns:

identifiers of flow classes whose priorities should fall below this one

higherIds

public Set<String> higherIds()

Description copied from interface: FlowClass

Returns the set of flow class identifiers whose actual priorities must be above this one.

Specified by:

higherIds in interface FlowClass

Returns:

identifiers of flow classes whose priorities should rise above this one

matchFields

public Set<OxmFieldType> matchFields()

Description copied from interface: FlowClass

Returns the set of field types expected to be set in the match.

Specified by:

matchFields in interface FlowClass

Returns:

set of expected fields

actions

public Set<FlowClass.ActionClass> actions()

Description copied from interface: FlowClass

Returns the set of expected action types.

Specified by:

actions in interface FlowClass

Returns:

set of expected actions