net.floodlightcontroller.hub
Class Hub

java.lang.Object
  net.floodlightcontroller.hub.Hub

All Implemented Interfaces:

IListener<OFType>, IOFMessageListener, IFloodlightModule

public class Hub
extends java.lang.Object
implements IFloodlightModule, IOFMessageListener

Author:

David Erickson (daviderickson@cs.stanford.edu) - 04/04/10

Nested Class Summary

Nested classes/interfaces inherited from interface net.floodlightcontroller.core.IListener

IListener.Command

Field Summary

protected IFloodlightProviderService	floodlightProvider
protected static org.slf4j.Logger	log

Constructor Summary

Hub()

Method Summary

java.util.Collection<java.lang.Class<? extends IFloodlightService>>	getModuleDependencies() Get a list of Modules that this module depends on.
java.util.Collection<java.lang.Class<? extends IFloodlightService>>	getModuleServices() Return the list of interfaces that this module implements.
java.lang.String	getName() The name assigned to this listener
java.util.Map<java.lang.Class<? extends IFloodlightService>,IFloodlightService>	getServiceImpls() Instantiate (as needed) and return objects that implement each of the services exported by this module.
void	init(FloodlightModuleContext context) This is a hook for each module to do its internal initialization, e.g., call setService(context.getService("Service")) All module dependencies are resolved when this is called, but not every module is initialized.
boolean	isCallbackOrderingPostreq(OFType type, java.lang.String name) Check if the module called name is a callback ordering post-requisite for this module.
boolean	isCallbackOrderingPrereq(OFType type, java.lang.String name) Check if the module called name is a callback ordering prerequisite for this module.
IListener.Command	receive(IOFSwitch sw, OFMessage msg, FloodlightContext cntx) This is the method Floodlight uses to call listeners with OpenFlow messages
void	setFloodlightProvider(IFloodlightProviderService floodlightProvider)
void	startUp(FloodlightModuleContext context) This is a hook for each module to do its external initializations, e.g., register for callbacks or query for state in other modules It is expected that this function will not block and that modules that want non-event driven CPU will spawn their own threads.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected static org.slf4j.Logger log

floodlightProvider

protected IFloodlightProviderService floodlightProvider

Constructor Detail

Hub

public Hub()

Method Detail

setFloodlightProvider

public void setFloodlightProvider(IFloodlightProviderService floodlightProvider)

Parameters:

floodlightProvider - the floodlightProvider to set

getName

public java.lang.String getName()

Description copied from interface: IListener

The name assigned to this listener

Specified by:

getName in interface IListener<OFType>

Returns:

receive

public IListener.Command receive(IOFSwitch sw,
                                 OFMessage msg,
                                 FloodlightContext cntx)

Description copied from interface: IOFMessageListener

This is the method Floodlight uses to call listeners with OpenFlow messages

Specified by:

receive in interface IOFMessageListener

Parameters:

sw - the OpenFlow switch that sent this message

msg - the message

cntx - a Floodlight message context object you can use to pass information between listeners

Returns:

the command to continue or stop the execution

isCallbackOrderingPrereq

public boolean isCallbackOrderingPrereq(OFType type,
                                        java.lang.String name)

Description copied from interface: IListener

Check if the module called name is a callback ordering prerequisite for this module. In other words, if this function returns true for the given name, then this listener will be called after that message listener.

Specified by:

isCallbackOrderingPrereq in interface IListener<OFType>

Parameters:

type - the object type to which this applies

name - the name of the module

Returns:

whether name is a prerequisite.

isCallbackOrderingPostreq

public boolean isCallbackOrderingPostreq(OFType type,
                                         java.lang.String name)

Description copied from interface: IListener

Check if the module called name is a callback ordering post-requisite for this module. In other words, if this function returns true for the given name, then this listener will be called before that message listener.

Specified by:

isCallbackOrderingPostreq in interface IListener<OFType>

Parameters:

type - the object type to which this applies

name - the name of the module

Returns:

whether name is a post-requisite.

getModuleServices

public java.util.Collection<java.lang.Class<? extends IFloodlightService>> getModuleServices()

Description copied from interface: IFloodlightModule

Return the list of interfaces that this module implements. All interfaces must inherit IFloodlightService

Specified by:

getModuleServices in interface IFloodlightModule

Returns:

getServiceImpls

public java.util.Map<java.lang.Class<? extends IFloodlightService>,IFloodlightService> getServiceImpls()

Description copied from interface: IFloodlightModule

Instantiate (as needed) and return objects that implement each of the services exported by this module. The map returned maps the implemented service to the object. The object could be the same object or different objects for different exported services.

Specified by:

getServiceImpls in interface IFloodlightModule

Returns:

The map from service interface class to service implementation

getModuleDependencies

public java.util.Collection<java.lang.Class<? extends IFloodlightService>> getModuleDependencies()

Description copied from interface: IFloodlightModule

Get a list of Modules that this module depends on. The module system will ensure that each these dependencies is resolved before the subsequent calls to init().

Specified by:

getModuleDependencies in interface IFloodlightModule

Returns:

The Collection of IFloodlightServices that this module depends on.

init

public void init(FloodlightModuleContext context)
          throws FloodlightModuleException

Description copied from interface: IFloodlightModule

This is a hook for each module to do its internal initialization, e.g., call setService(context.getService("Service")) All module dependencies are resolved when this is called, but not every module is initialized.

Specified by:

init in interface IFloodlightModule

Throws:

FloodlightModuleException

startUp

public void startUp(FloodlightModuleContext context)

Description copied from interface: IFloodlightModule

This is a hook for each module to do its external initializations, e.g., register for callbacks or query for state in other modules It is expected that this function will not block and that modules that want non-event driven CPU will spawn their own threads.

Specified by:

startUp in interface IFloodlightModule