org.onosproject.net.flow

Interface FlowRule

All Known Subinterfaces:

FlowEntry, StoredFlowEntry

All Known Implementing Classes:

DefaultFlowEntry, DefaultFlowRule

public interface FlowRule

Represents a generalized match & action pair to be applied to an infrastructure device.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FlowRule.Builder A flowrule builder.
static class	FlowRule.Type Deprecated.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_TIMEOUT
static int	MIN_PRIORITY

Method Summary

Modifier and Type	Method and Description
short	appId() Returns the application id of this flow.
DeviceId	deviceId() Returns the identity of the device where this rule applies.
GroupId	groupId() Returns the group id of this flow.
FlowId	id() Returns the ID of this flow.
boolean	isPermanent() Returns whether the flow is permanent i.e.
FlowRuleExtPayLoad	payLoad() Returns the third party original flow rule.
int	priority() Returns the flow rule priority given in natural order; higher numbers mean higher priorities.
TrafficSelector	selector() Returns the traffic selector that identifies what traffic this rule should apply to.
int	tableId() Returns the table id for this rule.
int	timeout() Returns the timeout for this flow requested by an application.
TrafficTreatment	treatment() Returns the traffic treatment that applies to selected traffic.

Field Detail

MAX_TIMEOUT

static final int MAX_TIMEOUT

See Also:

Constant Field Values

MIN_PRIORITY

static final int MIN_PRIORITY

See Also:

Constant Field Values

Method Detail

id

FlowId id()

Returns the ID of this flow.

Returns:

the flow ID

appId

short appId()

Returns the application id of this flow.

Returns:

an applicationId

groupId

GroupId groupId()

Returns the group id of this flow.

Returns:

an groupId

priority

int priority()

Returns the flow rule priority given in natural order; higher numbers mean higher priorities.

Returns:

flow rule priority

deviceId

DeviceId deviceId()

Returns the identity of the device where this rule applies.

Returns:

device identifier

selector

TrafficSelector selector()

Returns the traffic selector that identifies what traffic this rule should apply to.

Returns:

traffic selector

treatment

TrafficTreatment treatment()

Returns the traffic treatment that applies to selected traffic.

Returns:

traffic treatment

timeout

int timeout()

Returns the timeout for this flow requested by an application.

Returns:

integer value of the timeout

isPermanent

boolean isPermanent()

Returns whether the flow is permanent i.e. does not time out.

Returns:

true if the flow is permanent, otherwise false

tableId

int tableId()

Returns the table id for this rule.

Returns:

an integer.

payLoad

FlowRuleExtPayLoad payLoad()

Returns the third party original flow rule.

Returns:

FlowRuleExtPayLoad