Package org.onosproject.net.flow

Flow rule model & related services API definitions.

The figure below depicts the general interactions between different components of the intent subsystem.

Interface Summary

Interface	Description
BatchOperationResult<T>	Interface capturing the result of a batch operation.
Extension	An extension to the northbound APIs.
ExtensionSelectorCodec	Interface for encode and decode extension selector.
ExtensionTreatmentCodec	Interface for encode and decode extension treatment.
FlowEntry	Represents a generalized match & action pair to be applied to an infrastructure device.
FlowRule	Represents a generalized match & action pair to be applied to an infrastructure device.
FlowRule.Builder	A flowrule builder.
FlowRuleListener	Entity capable of receiving flow rule related events.
FlowRuleOperationsContext	The context of a flow rule operations that will become the subject of the notification.
FlowRuleProgrammable	Flow rule programmable device behaviour.
FlowRuleProvider	Abstraction of a flow rule provider.
FlowRuleProviderRegistry	Abstraction for a flow rule provider registry.
FlowRuleProviderService	Service through which flow rule providers can inject information into the core.
FlowRuleService	Service for injecting flow rules into the environment and for obtaining information about flow rules already in the environment.
FlowRuleStore	Manages inventory of flow rules; not intended for direct use.
FlowRuleStoreDelegate	Flow rule store delegate abstraction.
StoredFlowEntry
TableId	Match+action table identifier.
TableStatisticsEntry	Interface for flow table statistics of a device.
TrafficSelector	Abstraction of a slice of network traffic.
TrafficSelector.Builder	Builder of traffic selector entities.
TrafficTreatment	Abstraction of network traffic treatment.
TrafficTreatment.Builder	Builder of traffic treatment entities.
TypedStoredFlowEntry	Represents a flow live type for a given flow entry.

Class Summary

Class	Description
AbstractExtension	Abstract implementation of the set/get property methods of Extension.
BatchOperation<T extends BatchOperationEntry<?,?>>	A list of BatchOperationEntry.
BatchOperationEntry<T extends Enum<?>,U>	A super class for batch operation entry classes.
CompletedBatchOperation	Representation of a completed flow rule batch operation.
DefaultFlowEntry
DefaultFlowRule	Default flow rule.
DefaultFlowRule.Builder	Default flow rule builder.
DefaultTableStatisticsEntry	Default implementation of table statistics entry interface.
DefaultTableStatisticsEntry.Builder
DefaultTrafficSelector	Default traffic selector implementation.
DefaultTrafficSelector.Builder	Builder of traffic selector entities.
DefaultTrafficTreatment	Default traffic treatment implementation.
DefaultTrafficTreatment.Builder	Builds a list of treatments following the following order.
DefaultTypedFlowEntry	Default flow entry class with FlowLiveType value, IMMEDIATE_FLOW, SHORT_FLOW, MID_FLOW, LONG_FLOW.
FlowId	Representation of a Flow ID.
FlowRuleEvent	Describes flow rule event.
FlowRuleOperation	Representation of an operation on a flow rule table.
FlowRuleOperations	A batch of flow rule operations that are broken into stages.
FlowRuleOperations.Builder	A builder for constructing flow rule operations.
IndexTableId	Table identifier representing the position of the table in the pipeline.

Enum Summary

Enum	Description
FlowEntry.FlowEntryState
FlowEntry.FlowLiveType
FlowRule.FlowRemoveReason	Reason for flow parameter received from switches.
FlowRuleEvent.Type	Type of flow rule events.
FlowRuleOperation.Type	Type of flow table operations.
StatTriggerField	Stat fields are supported default by OXS.
StatTriggerFlag	Stat Trigger Flags.
TableId.Type	Types of table identifier.
TypedStoredFlowEntry.FlowLiveType

Exception Summary

Exception	Description
FlowRuleStoreException	Top level exception for FlowRuleStore failures.
FlowRuleStoreException.Interrupted	Flowrule store operation interrupted.
FlowRuleStoreException.Timeout	Flowrule store operation timeout.