org.onosproject.incubator.net.virtual

Interface VirtualNetworkFlowRuleStore

All Superinterfaces:

org.onosproject.store.Store<org.onosproject.net.flow.FlowRuleBatchEvent,org.onosproject.net.flow.FlowRuleStoreDelegate>

public interface VirtualNetworkFlowRuleStore
extends org.onosproject.store.Store<org.onosproject.net.flow.FlowRuleBatchEvent,org.onosproject.net.flow.FlowRuleStoreDelegate>

Method Summary

Modifier and Type	Method and Description
org.onosproject.net.flow.FlowRuleEvent	addOrUpdateFlowRule(NetworkId networkId, org.onosproject.net.flow.FlowEntry rule) Stores a new flow rule, or updates an existing entry.
void	batchOperationComplete(NetworkId networkId, org.onosproject.net.flow.FlowRuleBatchEvent event) Invoked on the completion of a storeBatch operation.
void	deleteFlowRule(NetworkId networkId, org.onosproject.net.flow.FlowRule rule) Marks a flow rule for deletion.
Iterable<org.onosproject.net.flow.FlowEntry>	getFlowEntries(NetworkId networkId, org.onosproject.net.DeviceId deviceId) Returns the flow entries associated with a device.
org.onosproject.net.flow.FlowEntry	getFlowEntry(NetworkId networkId, org.onosproject.net.flow.FlowRule rule) Returns the stored flow.
int	getFlowRuleCount(NetworkId networkId) Returns the number of flow rule in the store.
Iterable<org.onosproject.net.flow.TableStatisticsEntry>	getTableStatistics(NetworkId networkId, org.onosproject.net.DeviceId deviceId) Returns the flow table statistics associated with a device.
org.onosproject.net.flow.FlowRuleEvent	pendingFlowRule(NetworkId networkId, org.onosproject.net.flow.FlowEntry rule) Marks a flow rule as PENDING_ADD during retry.
default void	purgeFlowRule(NetworkId networkId, org.onosproject.net.DeviceId deviceId) Removes all flow entries of given device from store.
void	purgeFlowRules(NetworkId networkId) Removes all flow entries from store.
org.onosproject.net.flow.FlowRuleEvent	removeFlowRule(NetworkId networkId, org.onosproject.net.flow.FlowEntry rule) Removes an existing flow entry.
void	storeBatch(NetworkId networkId, org.onosproject.net.flow.FlowRuleBatchOperation batchOperation) Stores a batch of flow rules.
void	storeFlowRule(NetworkId networkId, org.onosproject.net.flow.FlowRule rule) Deprecated. in Cardinal Release
org.onosproject.net.flow.FlowRuleEvent	updateTableStatistics(NetworkId networkId, org.onosproject.net.DeviceId deviceId, List<org.onosproject.net.flow.TableStatisticsEntry> tableStats) Updates the flow table statistics of the specified device using the given statistics.

Methods inherited from interface org.onosproject.store.Store

hasDelegate, setDelegate, unsetDelegate

Method Detail

getFlowRuleCount

int getFlowRuleCount(NetworkId networkId)

Returns the number of flow rule in the store.

Parameters:

networkId - virtual network identifier

Returns:

number of flow rules

getFlowEntry

org.onosproject.net.flow.FlowEntry getFlowEntry(NetworkId networkId,
                                                org.onosproject.net.flow.FlowRule rule)

Returns the stored flow.

Parameters:

networkId - virtual network identifier

rule - the rule to look for

Returns:

a flow rule

getFlowEntries

Iterable<org.onosproject.net.flow.FlowEntry> getFlowEntries(NetworkId networkId,
                                                            org.onosproject.net.DeviceId deviceId)

Returns the flow entries associated with a device.

Parameters:

networkId - virtual network identifier

deviceId - the device ID

Returns:

the flow entries

storeFlowRule

@Deprecated
void storeFlowRule(NetworkId networkId,
                               org.onosproject.net.flow.FlowRule rule)

Deprecated. in Cardinal Release

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

Parameters:

networkId - virtual network identifier

rule - the flow rule to add

storeBatch

void storeBatch(NetworkId networkId,
                org.onosproject.net.flow.FlowRuleBatchOperation batchOperation)

Stores a batch of flow rules.

Parameters:

networkId - virtual network identifier

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

batchOperationComplete

void batchOperationComplete(NetworkId networkId,
                            org.onosproject.net.flow.FlowRuleBatchEvent event)

Invoked on the completion of a storeBatch operation.

Parameters:

networkId - virtual network identifier

event - flow rule batch event

deleteFlowRule

void deleteFlowRule(NetworkId networkId,
                    org.onosproject.net.flow.FlowRule rule)

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

Parameters:

networkId - virtual network identifier

rule - the flow rule to delete

addOrUpdateFlowRule

org.onosproject.net.flow.FlowRuleEvent addOrUpdateFlowRule(NetworkId networkId,
                                                           org.onosproject.net.flow.FlowEntry rule)

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

Parameters:

networkId - virtual network identifier

rule - the flow rule to add or update

Returns:

flow_added event, or null if just an update

removeFlowRule

org.onosproject.net.flow.FlowRuleEvent removeFlowRule(NetworkId networkId,
                                                      org.onosproject.net.flow.FlowEntry rule)

Removes an existing flow entry.

Parameters:

rule - the flow entry to remove

networkId - virtual network identifier

Returns:

flow_removed event, or null if nothing removed

pendingFlowRule

org.onosproject.net.flow.FlowRuleEvent pendingFlowRule(NetworkId networkId,
                                                       org.onosproject.net.flow.FlowEntry rule)

Marks a flow rule as PENDING_ADD during retry. Emits flow_update event if the state is changed

Parameters:

networkId - virtual network identifier

rule - the flow rule that is retrying

Returns:

flow_updated event, or null if nothing updated

purgeFlowRule

default void purgeFlowRule(NetworkId networkId,
                           org.onosproject.net.DeviceId deviceId)

Removes all flow entries of given device from store.

Parameters:

networkId - virtual network identifier

deviceId - device id

purgeFlowRules

void purgeFlowRules(NetworkId networkId)

Removes all flow entries from store.

Parameters:

networkId - virtual network identifier

updateTableStatistics

org.onosproject.net.flow.FlowRuleEvent updateTableStatistics(NetworkId networkId,
                                                             org.onosproject.net.DeviceId deviceId,
                                                             List<org.onosproject.net.flow.TableStatisticsEntry> tableStats)

Updates the flow table statistics of the specified device using the given statistics.

Parameters:

networkId - virtual network identifier

deviceId - device identifier

tableStats - list of table statistics

Returns:

ready to send event describing what occurred;

getTableStatistics

Iterable<org.onosproject.net.flow.TableStatisticsEntry> getTableStatistics(NetworkId networkId,
                                                                           org.onosproject.net.DeviceId deviceId)

Returns the flow table statistics associated with a device.

Parameters:

networkId - virtual network identifier

deviceId - the device ID

Returns:

the flow table statistics