net.floodlightcontroller.core.internal

Interface IOFSwitchService

All Superinterfaces:

IFloodlightService

All Known Implementing Classes:

OFSwitchManager

public interface IOFSwitchService
extends IFloodlightService

Method Summary

Modifier and Type	Method and Description
void	addOFSwitchDriver(java.lang.String manufacturerDescriptionPrefix, IOFSwitchDriver driver) Add a switch driver
void	addOFSwitchListener(IOFSwitchListener listener) Add a switch listener
IOFSwitch	getActiveSwitch(org.projectfloodlight.openflow.types.DatapathId dpid) If the switch with the given DPID is known to any controller in the cluster, this method returns the associated IOFSwitch instance.
java.util.Set<org.projectfloodlight.openflow.types.DatapathId>	getAllSwitchDpids() Returns a snapshot of the set DPIDs for all known switches.
java.util.Map<org.projectfloodlight.openflow.types.DatapathId,IOFSwitch>	getAllSwitchMap() Get's the switch map stored in the switch manager
IOFSwitch	getSwitch(org.projectfloodlight.openflow.types.DatapathId dpid) If the switch with the given DPID is known to any controller in the cluster, this method returns the associated IOFSwitch instance.
java.util.List<OFSwitchHandshakeHandler>	getSwitchHandshakeHandlers() Gets an immutable list of handshake handlers.
void	registerHandshakePlugin(IAppHandshakePluginFactory plugin) Registers an app handshake plugin to be used during switch handshaking.
void	registerLogicalOFMessageCategory(LogicalOFMessageCategory category) Registers a logical OFMessage category to be used by an application
void	removeOFSwitchListener(IOFSwitchListener listener) Remove a switch listener

Method Detail

getAllSwitchMap

java.util.Map<org.projectfloodlight.openflow.types.DatapathId,IOFSwitch> getAllSwitchMap()

Get's the switch map stored in the switch manager

Returns:

the map of switches known by the switch manager

getSwitch

IOFSwitch getSwitch(org.projectfloodlight.openflow.types.DatapathId dpid)

If the switch with the given DPID is known to any controller in the cluster, this method returns the associated IOFSwitch instance. As such the returned switches not necessarily connected or in master role for the local controller. Multiple calls to this method with the same DPID may return different IOFSwitch references. A caller must not store or otherwise rely on IOFSwitch references to be constant over the lifecycle of a switch.

Parameters:

dpid - the dpid of the switch to query

Returns:

the IOFSwitch instance associated with the dpid, null if no switch with the dpid is known to the cluster

getActiveSwitch

IOFSwitch getActiveSwitch(org.projectfloodlight.openflow.types.DatapathId dpid)

If the switch with the given DPID is known to any controller in the cluster, this method returns the associated IOFSwitch instance. As such the returned switches not necessarily connected or in master role for the local controller. Multiple calls to this method with the same DPID may return different IOFSwitch references. A caller must not store or otherwise rely on IOFSwitch references to be constant over the lifecycle of a switch.

Parameters:

dpid - the dpid of the switch to query

Returns:

the IOFSwitch instance associated with the dpid, null if no switch with the dpid is known to the cluster OR if the switch status is not considered visible.

addOFSwitchListener

void addOFSwitchListener(IOFSwitchListener listener)

Add a switch listener

Parameters:

listener - The module that wants to listen for events

addOFSwitchDriver

void addOFSwitchDriver(java.lang.String manufacturerDescriptionPrefix,
                       IOFSwitchDriver driver)

Add a switch driver

Parameters:

manufacturerDescriptionPrefix -

driver -

removeOFSwitchListener

void removeOFSwitchListener(IOFSwitchListener listener)

Remove a switch listener

Parameters:

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

registerLogicalOFMessageCategory

void registerLogicalOFMessageCategory(LogicalOFMessageCategory category)

Registers a logical OFMessage category to be used by an application

Parameters:

category - the logical OFMessage category

registerHandshakePlugin

void registerHandshakePlugin(IAppHandshakePluginFactory plugin)

Registers an app handshake plugin to be used during switch handshaking.

Parameters:

plugin - the app handshake plugin to be used during switch handshaking.

getAllSwitchDpids

java.util.Set<org.projectfloodlight.openflow.types.DatapathId> getAllSwitchDpids()

Returns a snapshot of the set DPIDs for all known switches. The returned set is owned by the caller: the caller can modify it at will and changes to the known switches are not reflected in the returned set. The caller needs to call getAllSwitchDpids() if an updated version is needed. See #getSwitch(long) for what "known" switch is.

Returns:

the set of DPIDs of all known switches

getSwitchHandshakeHandlers

java.util.List<OFSwitchHandshakeHandler> getSwitchHandshakeHandlers()

Gets an immutable list of handshake handlers.

Returns:

an immutable list of handshake handlers.