etri.sdn.controller.module.flowcache

Interface IFlowCacheService

All Superinterfaces:

IService

public interface IFlowCacheService
extends IService

The Interface IFlowCache.

public interface APIs to Big Switch Flow-Cache Service. Flow-Cache maintains the network-level flows that are currently deployed in the underlying network. The flow cache can be queried using various filters by using the corresponding APIs.

Author:

subrata

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IFlowCacheService.FCQueryEvType The flow cache query event type indicating the event that triggered the query.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FLOWCACHE_APP_INSTANCE_NAME
static java.lang.String	FLOWCACHE_APP_NAME

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addFlow(MessageContext cntx, OFMatchWithSwDpid ofm, java.lang.Long cookie, SwitchPort swPort, short priority, byte action) Add a flow to the flow-cache - called when a flow-mod is about to be written to a set of switches.
boolean	addFlow(java.lang.String appInstName, OFMatchWithSwDpid ofm, java.lang.Long cookie, long srcSwDpid, short inPort, short priority, byte action) Add a flow to the flow-cache - called when a flow-mod is about to be written to a set of switches.
void	deactivateFlowCacheBySwitch(long switchDpid) Deactivates all flows in the flow cache for which the source switch matches the given switchDpid.
void	deleteAllFlowsAtASourceSwitch(IOFSwitch sw) Delete all flow from the specified switch
void	deleteFlowCacheBySwitch(long switchDpid) Deletes all flows in the flow cache for which the source switch matches the given switchDpid.
boolean	moveFlowToDifferentApplInstName(OFMatchReconcile ofMRc) Move the specified flow from its current application instance to a different application instance.
void	querySwitchFlowTable(long swDpid) Post a request to update flowcache from a switch.
void	submitFlowCacheQuery(FCQueryObj query) Submit a flow cache query with query parameters specified in FCQueryObj object.

Field Detail

FLOWCACHE_APP_NAME

static final java.lang.String FLOWCACHE_APP_NAME

See Also:

Constant Field Values

FLOWCACHE_APP_INSTANCE_NAME

static final java.lang.String FLOWCACHE_APP_INSTANCE_NAME

See Also:

Constant Field Values

Method Detail

submitFlowCacheQuery

void submitFlowCacheQuery(FCQueryObj query)

Submit a flow cache query with query parameters specified in FCQueryObj object. The query object can be created using one of the newFCQueryObj helper functions in IFlowCache interface.

The queried flows are returned via the flowQueryRespHandler() callback that the caller must implement. The caller can match the query with the response using unique callerOpaqueData which remains unchanged in the request and response callback.

Parameters:

query - the flow cache query object as input

See Also:

com.bigswitch.floodlight.flowcache#flowQueryRespHandler

deactivateFlowCacheBySwitch

void deactivateFlowCacheBySwitch(long switchDpid)

Deactivates all flows in the flow cache for which the source switch matches the given switchDpid. Note that the flows are NOT deleted from the cache.

Parameters:

switchDpid - Data-path identifier of the source switch

deleteFlowCacheBySwitch

void deleteFlowCacheBySwitch(long switchDpid)

Deletes all flows in the flow cache for which the source switch matches the given switchDpid.

Parameters:

switchDpid - Data-path identifier of the source switch

addFlow

boolean addFlow(java.lang.String appInstName,
              OFMatchWithSwDpid ofm,
              java.lang.Long cookie,
              long srcSwDpid,
              short inPort,
              short priority,
              byte action)

Add a flow to the flow-cache - called when a flow-mod is about to be written to a set of switches. If it returns false then it should not be written to the switches. If it returns true then the cookie returned should be used for the flow mod sent to the switches.

Parameters:

appInstName - Application instance name

ofm - openflow match object

cookie - openflow-mod cookie

srcSwDpid - source switch dpid

inPort - input port

priority - openflow match priority

action - action taken on the matched packets (PERMIT or DENY)

Returns:

true: flow should be written to the switch(es) false: flow should not be written to the switch(es). false is returned, for example, when the flow was recently written to the flow-cache and hence it is dampened to avoid frequent writes of the same flow to the switches This case can typically arise for the flows written at the internal ports as they are heavily wild-carded.

addFlow

boolean addFlow(MessageContext cntx,
              OFMatchWithSwDpid ofm,
              java.lang.Long cookie,
              SwitchPort swPort,
              short priority,
              byte action)

Add a flow to the flow-cache - called when a flow-mod is about to be written to a set of switches. If it returns false then it should not be written to the switches. If it returns true then the cookie returned should be used for the flow mod sent to the switches.

Parameters:

cntx - the cntx

ofm - the ofm

cookie - the cookie

swPort - the sw port

priority - the priority

action - the action

Returns:

true: flow should be written to the switch(es) false: flow should not be written to the switch(es). false is returned, for example, when the flow was recently written to the flow-cache and hence it is dampened to avoid frequent writes of the same flow to the switches This case can typically arise for the flows written at the internal ports as they are heavily wild-carded.

moveFlowToDifferentApplInstName

boolean moveFlowToDifferentApplInstName(OFMatchReconcile ofMRc)

Move the specified flow from its current application instance to a different application instance. This API can be used when a flow moves to a different application instance when the application instance configuration changes or when a device moves to a different part in the network that belongs to a different application instance.

Note that, if the flow was not found in the current application instance then the flow is not moved to the new application instance.

Parameters:

ofMRc - the object containing the flow match and new application instance name.

Returns:

true is the flow was found in the flow cache in the current application instance; false if the flow was not found in the flow-cache in the current application instance.

deleteAllFlowsAtASourceSwitch

void deleteAllFlowsAtASourceSwitch(IOFSwitch sw)

Delete all flow from the specified switch

Parameters:

sw -

querySwitchFlowTable

void querySwitchFlowTable(long swDpid)

Post a request to update flowcache from a switch. This is an asynchronous operation. It queries the switch for stats and updates the flowcache asynchronously with the response.

Parameters:

swDpid -