com.hp.of.ctl.prio

Interface FlowClass

All Known Implementing Classes:

FlowClassAdapter

public interface FlowClass

Record of flow mod class registration.

Author:

Thomas Vachuska, Simon Hunt, Uyen Chau

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FlowClass.ActionClass Coarse classification of type of action.

Field Summary

Fields

Modifier and Type	Field and Description
static long	COOKIE_MASK Mask for isolating assigned base cookie value, which is the top 16 bits.

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.

Field Detail

COOKIE_MASK

static final long COOKIE_MASK

Mask for isolating assigned base cookie value, which is the top 16 bits.

See Also:

Constant Field Values

Method Detail

priority

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.

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

Returns:

unique and opaque value representing the relative priority

Throws:

IllegalStateException - if accessed on instances other than one immediately returned during registration

actualPriority

int actualPriority()

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

Returns:

actual priority value

Throws:

IllegalStateException - if accessed on instances other than one immediately returned during registration

baseCookie

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. 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.

Returns:

assigned base cookie

id

String id()

Returns the global flow class identifier.

Returns:

flow class id

password

String password()

Returns the password specified by the application during registration.

Returns:

password

description

String description()

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

Returns:

purpose narrative for this class

lowerIds

Set<String> lowerIds()

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

Returns:

identifiers of flow classes whose priorities should fall below this one

higherIds

Set<String> higherIds()

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

Returns:

identifiers of flow classes whose priorities should rise above this one

matchFields

Set<OxmFieldType> matchFields()

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

Returns:

set of expected fields

actions

Set<FlowClass.ActionClass> actions()

Returns the set of expected action types.

Returns:

set of expected actions