org.onosproject.net.flow

Interface FlowRuleStore

All Superinterfaces:

Store<FlowRuleBatchEvent,FlowRuleStoreDelegate>

public interface FlowRuleStore
extends Store<FlowRuleBatchEvent,FlowRuleStoreDelegate>

Manages inventory of flow rules; not intended for direct use.

Method Summary

Modifier and Type	Method and Description
FlowRuleEvent	addOrUpdateFlowRule(FlowEntry rule) Stores a new flow rule, or updates an existing entry.
void	batchOperationComplete(FlowRuleBatchEvent event) Invoked on the completion of a storeBatch operation.
void	deleteFlowRule(FlowRule rule) Marks a flow rule for deletion.
Iterable<FlowEntry>	getFlowEntries(DeviceId deviceId) Returns the flow entries associated with a device.
FlowEntry	getFlowEntry(FlowRule rule) Returns the stored flow.
int	getFlowRuleCount() Returns the number of flow rule in the store.
FlowRuleEvent	removeFlowRule(FlowEntry rule)
Future<CompletedBatchOperation>	storeBatch(FlowRuleBatchOperation batchOperation) Stores a batch of flow rules.
void	storeFlowRule(FlowRule rule) // TODO: Better description of method behavior.

Methods inherited from interface org.onosproject.store.Store

hasDelegate, setDelegate, unsetDelegate

Method Detail

getFlowRuleCount

int getFlowRuleCount()

Returns the number of flow rule in the store.

Returns:

number of flow rules

getFlowEntry

FlowEntry getFlowEntry(FlowRule rule)

Returns the stored flow.

Parameters:

rule - the rule to look for

Returns:

a flow rule

getFlowEntries

Iterable<FlowEntry> getFlowEntries(DeviceId deviceId)

Returns the flow entries associated with a device.

Parameters:

deviceId - the device ID

Returns:

the flow entries

storeFlowRule

void storeFlowRule(FlowRule rule)

// TODO: Better description of method behavior. Stores a new flow rule without generating events.

Parameters:

rule - the flow rule to add

storeBatch

Future<CompletedBatchOperation> storeBatch(FlowRuleBatchOperation batchOperation)

Stores a batch of flow rules.

Parameters:

batchOperation - batch of flow rules. A batch can contain flow rules for a single device only.

Returns:

Future response indicating success/failure of the batch operation all the way down to the device.

batchOperationComplete

void batchOperationComplete(FlowRuleBatchEvent event)

Invoked on the completion of a storeBatch operation.

Parameters:

event - flow rule batch event

deleteFlowRule

void deleteFlowRule(FlowRule rule)

Marks a flow rule for deletion. Actual deletion will occur when the provider indicates that the flow has been removed.

Parameters:

rule - the flow rule to delete

addOrUpdateFlowRule

FlowRuleEvent addOrUpdateFlowRule(FlowEntry rule)

Stores a new flow rule, or updates an existing entry.

Parameters:

rule - the flow rule to add or update

Returns:

flow_added event, or null if just an update

removeFlowRule

FlowRuleEvent removeFlowRule(FlowEntry rule)

Parameters:

rule - the flow entry to remove

Returns:

flow_removed event, or null if nothing removed