org.onosproject.net.flow

Interface FlowRuleService

public interface FlowRuleService

Service for injecting flow rules into the environment and for obtaining information about flow rules already in the environment. This implements semantics of a distributed authoritative flow table where the master copy of the flow rules lies with the controller and the devices hold only the 'cached' copy.

Method Summary

Modifier and Type	Method and Description
void	addListener(FlowRuleListener listener) Adds the specified flow rule listener.
Future<CompletedBatchOperation>	applyBatch(FlowRuleBatchOperation batch) Applies a batch operation of FlowRules.
void	applyFlowRules(FlowRule... flowRules) Applies the specified flow rules onto their respective devices.
Iterable<FlowEntry>	getFlowEntries(DeviceId deviceId) Returns the collection of flow entries applied on the specified device.
int	getFlowRuleCount() Returns the number of flow rules in the system.
Iterable<FlowRule>	getFlowRulesByGroupId(ApplicationId appId, short groupId) Returns a list of rules filterd by application and group id.
Iterable<FlowRule>	getFlowRulesById(ApplicationId id) Returns a list of rules with this application id.
void	removeFlowRules(FlowRule... flowRules) Removes the specified flow rules from their respective devices.
void	removeFlowRulesById(ApplicationId appId) Removes all rules by id.
void	removeListener(FlowRuleListener listener) Removes the specified flow rule listener.

Method Detail

getFlowRuleCount

int getFlowRuleCount()

Returns the number of flow rules in the system.

Returns:

flow rule count

getFlowEntries

Iterable<FlowEntry> getFlowEntries(DeviceId deviceId)

Returns the collection of flow entries applied on the specified device. This will include flow rules which may not yet have been applied to the device.

Parameters:

deviceId - device identifier

Returns:

collection of flow rules

applyFlowRules

void applyFlowRules(FlowRule... flowRules)

Applies the specified flow rules onto their respective devices. These flow rules will be retained by the system and re-applied anytime the device reconnects to the controller.

Parameters:

flowRules - one or more flow rules

removeFlowRules

void removeFlowRules(FlowRule... flowRules)

Removes the specified flow rules from their respective devices. If the device is not presently connected to the controller, these flow will be removed once the device reconnects.

Parameters:

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

removeFlowRulesById

void removeFlowRulesById(ApplicationId appId)

Removes all rules by id.

Parameters:

appId - id to remove

getFlowRulesById

Iterable<FlowRule> getFlowRulesById(ApplicationId id)

Returns a list of rules with this application id.

Parameters:

id - the id to look up

Returns:

collection of flow rules

getFlowRulesByGroupId

Iterable<FlowRule> getFlowRulesByGroupId(ApplicationId appId,
                                         short groupId)

Returns a list of rules filterd by application and group id.

Parameters:

appId - the application id to lookup

groupId - the groupid to lookup

Returns:

collection of flow rules

applyBatch

Future<CompletedBatchOperation> applyBatch(FlowRuleBatchOperation batch)

Applies a batch operation of FlowRules.

Parameters:

batch - batch operation to apply

Returns:

future indicating the state of the batch operation

addListener

void addListener(FlowRuleListener listener)

Adds the specified flow rule listener.

Parameters:

listener - flow rule listener

removeListener

void removeListener(FlowRuleListener listener)

Removes the specified flow rule listener.

Parameters:

listener - flow rule listener