net.floodlightcontroller.counter
Interface ICounterStoreService

All Superinterfaces:
IFloodlightService
All Known Implementing Classes:
CounterStore, NullCounterStore

public interface ICounterStoreService
extends IFloodlightService


Field Summary
static java.lang.String BROADCAST
          Broadcast and multicast
static java.lang.String CONTROLLER_NAME
           
static java.lang.String L3ET_IPV4
          L2 EtherType subCategories
static java.lang.String MULTICAST
           
static java.lang.String TitleDelimitor
           
static java.lang.String UNICAST
           
 
Method Summary
 ICounter createCounter(java.lang.String key, CounterValue.CounterType type)
          Create a new ICounter and set the title.
 java.util.Map<java.lang.String,ICounter> getAll()
          Returns an immutable map of title:counter with all of the counters in the store.
 java.util.List<java.lang.String> getAllCategories(java.lang.String counterName, CounterStore.NetworkLayer layer)
          Retrieve a list of subCategories by counterName.
 ICounter getCounter(java.lang.String key)
          Retrieves a counter with the given title, or null if none can be found.
 void updateFlush()
          Flush Local Counter Updates
 void updatePacketInCountersLocal(IOFSwitch sw, OFMessage m, Ethernet eth)
          Update packetIn counters
 void updatePktOutFMCounterStoreLocal(IOFSwitch sw, OFMessage ofMsg)
          This method can only be used to update packetOut and flowmod counters
 

Field Detail

CONTROLLER_NAME

static final java.lang.String CONTROLLER_NAME
See Also:
Constant Field Values

TitleDelimitor

static final java.lang.String TitleDelimitor
See Also:
Constant Field Values

BROADCAST

static final java.lang.String BROADCAST
Broadcast and multicast

See Also:
Constant Field Values

MULTICAST

static final java.lang.String MULTICAST
See Also:
Constant Field Values

UNICAST

static final java.lang.String UNICAST
See Also:
Constant Field Values

L3ET_IPV4

static final java.lang.String L3ET_IPV4
L2 EtherType subCategories

See Also:
Constant Field Values
Method Detail

updatePacketInCountersLocal

void updatePacketInCountersLocal(IOFSwitch sw,
                                 OFMessage m,
                                 Ethernet eth)
Update packetIn counters

Parameters:
sw -
m -
eth -

updatePktOutFMCounterStoreLocal

void updatePktOutFMCounterStoreLocal(IOFSwitch sw,
                                     OFMessage ofMsg)
This method can only be used to update packetOut and flowmod counters

Parameters:
sw -
ofMsg -

updateFlush

void updateFlush()
Flush Local Counter Updates


getAllCategories

java.util.List<java.lang.String> getAllCategories(java.lang.String counterName,
                                                  CounterStore.NetworkLayer layer)
Retrieve a list of subCategories by counterName. null if nothing.


createCounter

ICounter createCounter(java.lang.String key,
                       CounterValue.CounterType type)
Create a new ICounter and set the title. Note that the title must be unique, otherwise this will throw an IllegalArgumentException.

Parameters:
key -
type -
Returns:

getCounter

ICounter getCounter(java.lang.String key)
Retrieves a counter with the given title, or null if none can be found.


getAll

java.util.Map<java.lang.String,ICounter> getAll()
Returns an immutable map of title:counter with all of the counters in the store. (Note - this method may be slow - primarily for debugging/UI)