net.floodlightcontroller.core

Interface IFloodlightProviderService

All Superinterfaces:

IFloodlightService, java.lang.Runnable

All Known Implementing Classes:

Controller

public interface IFloodlightProviderService
extends IFloodlightService, java.lang.Runnable

The interface exposed by the core bundle that allows you to interact with connected switches.

Author:

David Erickson (daviderickson@cs.stanford.edu)

Field Summary

Fields

Modifier and Type	Field and Description
static FloodlightContextStore<Ethernet>	bcStore A FloodlightContextStore object that can be used to retrieve the packet-in payload
static java.lang.String	CONTEXT_PI_PAYLOAD A value stored in the floodlight context containing a parsed packet representation of the payload of a packet-in message.
static java.lang.String	SERVICE_DIRECTORY_SERVICE_NAME Service name used in the service directory representing the OpenFlow controller-switch channel

Method Summary

Modifier and Type	Method and Description
void	addCompletionListener(IControllerCompletionListener listener) Add a completion listener to the controller
void	addHAListener(IHAListener listener) Adds a listener for HA role events
void	addInfoProvider(java.lang.String type, IInfoProvider provider) Add an info provider of a particular type
void	addOFMessageListener(org.projectfloodlight.openflow.protocol.OFType type, IOFMessageListener listener) Adds an OpenFlow message listener
void	addUpdateToQueue(Controller.IUpdate update) Add an update task for asynchronous, serialized execution
java.lang.String	getControllerId() Gets the ID of the controller
java.util.Map<java.lang.String,java.lang.Object>	getControllerInfo(java.lang.String type) Return information of a particular type (for rest services)
java.util.Map<java.lang.String,java.lang.String>	getControllerNodeIPs() Get the current mapping of controller IDs to their IP addresses Returns a copy of the current mapping.
java.util.Map<org.projectfloodlight.openflow.protocol.OFType,java.util.List<IOFMessageListener>>	getListeners() Return a non-modifiable list of all current listeners
java.util.Map<java.lang.String,java.lang.Long>	getMemory() Get controller memory information
Controller.ModuleLoaderState	getModuleLoaderState() Gets the current module loading state.
HARole	getRole() Get the current role of the controller
RoleInfo	getRoleInfo() Get the current role of the controller
RoleManager	getRoleManager() Gets the role manager
long	getSystemStartTime() Return the controller start time in milliseconds
java.lang.Long	getUptime() returns the uptime of this controller.
void	handleMessage(IOFSwitch sw, org.projectfloodlight.openflow.protocol.OFMessage m, FloodlightContext bContext)
void	handleOutgoingMessage(IOFSwitch sw, org.projectfloodlight.openflow.protocol.OFMessage m) Process written messages through the message listeners for the controller
void	removeCompletionListener(IControllerCompletionListener listener) Remove a completion listener from the controller
void	removeHAListener(IHAListener listener) Removes a listener for HA role events
void	removeInfoProvider(java.lang.String type, IInfoProvider provider) Remove an info provider of a particular type
void	removeOFMessageListener(org.projectfloodlight.openflow.protocol.OFType type, IOFMessageListener listener) Removes an OpenFlow message listener
void	run() Run the main I/O loop of the Controller.
void	setRole(HARole role, java.lang.String changeDescription) Set the role of the controller

Field Detail

CONTEXT_PI_PAYLOAD

static final java.lang.String CONTEXT_PI_PAYLOAD

A value stored in the floodlight context containing a parsed packet representation of the payload of a packet-in message.

See Also:

Constant Field Values

bcStore

static final FloodlightContextStore<Ethernet> bcStore

A FloodlightContextStore object that can be used to retrieve the packet-in payload

SERVICE_DIRECTORY_SERVICE_NAME

static final java.lang.String SERVICE_DIRECTORY_SERVICE_NAME

Service name used in the service directory representing the OpenFlow controller-switch channel

See Also:

ILocalServiceAddressTracker, IClusterServiceAddressDirectory, Constant Field Values

Method Detail

addOFMessageListener

void addOFMessageListener(org.projectfloodlight.openflow.protocol.OFType type,
                          IOFMessageListener listener)

Adds an OpenFlow message listener

Parameters:

type - The OFType the component wants to listen for

listener - The component that wants to listen for the message

removeOFMessageListener

void removeOFMessageListener(org.projectfloodlight.openflow.protocol.OFType type,
                             IOFMessageListener listener)

Removes an OpenFlow message listener

Parameters:

type - The OFType the component no long wants to listen for

listener - The component that no longer wants to receive the message

getListeners

java.util.Map<org.projectfloodlight.openflow.protocol.OFType,java.util.List<IOFMessageListener>> getListeners()

Return a non-modifiable list of all current listeners

Returns:

listeners

getRole

HARole getRole()

Get the current role of the controller

getRoleInfo

RoleInfo getRoleInfo()

Get the current role of the controller

getControllerNodeIPs

java.util.Map<java.lang.String,java.lang.String> getControllerNodeIPs()

Get the current mapping of controller IDs to their IP addresses Returns a copy of the current mapping.

See Also:

IHAListener

getControllerId

java.lang.String getControllerId()

Gets the ID of the controller

setRole

void setRole(HARole role,
             java.lang.String changeDescription)

Set the role of the controller

Parameters:

role - The new role for the controller node

changeDescription - The reason or other information for this role change

addUpdateToQueue

void addUpdateToQueue(Controller.IUpdate update)

Add an update task for asynchronous, serialized execution

Parameters:

update -

addHAListener

void addHAListener(IHAListener listener)

Adds a listener for HA role events

Parameters:

listener - The module that wants to listen for events

removeHAListener

void removeHAListener(IHAListener listener)

Removes a listener for HA role events

Parameters:

listener - The module that no longer wants to listen for events

handleOutgoingMessage

void handleOutgoingMessage(IOFSwitch sw,
                           org.projectfloodlight.openflow.protocol.OFMessage m)

Process written messages through the message listeners for the controller

Parameters:

sw - The switch being written to

m - the message

Throws:

java.lang.NullPointerException - if switch or msg is null

run

void run()

Run the main I/O loop of the Controller.

Specified by:

run in interface java.lang.Runnable

addInfoProvider

void addInfoProvider(java.lang.String type,
                     IInfoProvider provider)

Add an info provider of a particular type

Parameters:

type -

provider -

removeInfoProvider

void removeInfoProvider(java.lang.String type,
                        IInfoProvider provider)

Remove an info provider of a particular type

Parameters:

type -

provider -

getControllerInfo

java.util.Map<java.lang.String,java.lang.Object> getControllerInfo(java.lang.String type)

Return information of a particular type (for rest services)

Parameters:

type -

Returns:

getSystemStartTime

long getSystemStartTime()

Return the controller start time in milliseconds

Returns:

getMemory

java.util.Map<java.lang.String,java.lang.Long> getMemory()

Get controller memory information

getUptime

java.lang.Long getUptime()

returns the uptime of this controller.

Returns:

handleMessage

void handleMessage(IOFSwitch sw,
                   org.projectfloodlight.openflow.protocol.OFMessage m,
                   FloodlightContext bContext)

getRoleManager

RoleManager getRoleManager()

Gets the role manager

Returns:

the role manager

getModuleLoaderState

Controller.ModuleLoaderState getModuleLoaderState()

Gets the current module loading state.

Returns:

the current module loading state.

addCompletionListener

void addCompletionListener(IControllerCompletionListener listener)

Add a completion listener to the controller

Parameters:

listener -

removeCompletionListener

void removeCompletionListener(IControllerCompletionListener listener)

Remove a completion listener from the controller

Parameters:

listener -