org.onosproject.net.flow

Interface FlowRuleProvider

All Superinterfaces:

Provider

public interface FlowRuleProvider
extends Provider

Abstraction of a flow rule provider.

Field Summary

Fields

Modifier and Type	Field and Description
static int	POLL_INTERVAL

Method Summary

Modifier and Type	Method and Description
void	applyFlowRule(FlowRule... flowRules) Instructs the provider to apply the specified flow rules to their respective devices.
Future<CompletedBatchOperation>	executeBatch(BatchOperation<FlowRuleBatchEntry> batch) Installs a batch of flow rules.
void	removeFlowRule(FlowRule... flowRules) Instructs the provider to remove the specified flow rules to their respective devices.
void	removeRulesById(ApplicationId id, FlowRule... flowRules) Removes rules by their id.

Methods inherited from interface org.onosproject.net.provider.Provider

id

Field Detail

POLL_INTERVAL

static final int POLL_INTERVAL

See Also:

Constant Field Values

Method Detail

applyFlowRule

void applyFlowRule(FlowRule... flowRules)

Instructs the provider to apply the specified flow rules to their respective devices.

Parameters:

flowRules - one or more flow rules throws SomeKindOfException that indicates which ones were applied and which ones failed

removeFlowRule

void removeFlowRule(FlowRule... flowRules)

Instructs the provider to remove the specified flow rules to their respective devices.

Parameters:

flowRules - one or more flow rules throws SomeKindOfException that indicates which ones were applied and which ones failed

removeRulesById

void removeRulesById(ApplicationId id,
                     FlowRule... flowRules)

Removes rules by their id.

Parameters:

id - the id to remove

flowRules - one or more flow rules

executeBatch

Future<CompletedBatchOperation> executeBatch(BatchOperation<FlowRuleBatchEntry> batch)

Installs a batch of flow rules. Each flowrule is associated to an operation which results in either addition, removal or modification.

Parameters:

batch - a batch of flow rules

Returns:

a future indicating the status of this execution