etri.sdn.controller

Class OFController

java.lang.Object

etri.sdn.controller.OFController

All Implemented Interfaces:

IOFHandler, java.lang.Comparable<IOFHandler>

public abstract class OFController
extends java.lang.Object
implements IOFHandler, java.lang.Comparable<IOFHandler>

Mother of all OpenFlow controller implementations.

Author:

bjlee

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	OFController.QI Queue Item
private class	OFController.QP Queue Item Processor, which is a thread that pulls QI object from the queue that is associated with the thread.

Nested classes/interfaces inherited from interface etri.sdn.controller.protocol.io.IOFHandler

IOFHandler.Role

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Set<OFModule>	modules set of all modules.
private OFController.QP[]	processors Queue Item Processors
private OFProtocol	protocol
private IOFHandler.Role	role role of this controller.
private IOFProtocolServer	server Protocol Server object, which is currently TcpServer.
private java.util.concurrent.ConcurrentHashMap<java.lang.Long,IOFSwitch>	switches index to all switches.
private java.util.Timer	timer Timer for scheduling asynchronous jobs.

Constructor Summary

Constructors

Constructor and Description
OFController(int num_of_queue, java.lang.String role) OFController constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addModule(OFModule module) This method is automatically called by OFModule.init(IOFHandler).
void	addSwitch(long id, IOFSwitch sw)
int	compareTo(IOFHandler o)
java.lang.String	getConcatenatedModuleNames() get a String representation of all module names linked with ','.
OFModel[]	getModels() This method returns all the OFModel object which are associated with this controller.
java.lang.String[]	getModuleNames() get an array that holds all the module names associated with this controller.
java.util.Collection<OFModule>	getModules() get all the OFModule objects associated with this controller.
OFProtocol	getProtocol()
IOFHandler.Role	getRole() get the role of this controller.
IOFSwitch	getSwitch(long id) return a specific switch with a given identifier
java.util.Collection<IOFSwitch>	getSwitches() return the set of all switches
java.util.Set<java.lang.Long>	getSwitchIdentifiers() return the set of all switch identifiers
boolean	handleConnectedEvent(Connection conn) This callback is called when a new connection to a new switch is made.
boolean	handleDisconnectEvent(Connection conn) This callback is called when a connection to a switch is lost.
abstract boolean	handleGeneric(Connection conn, MessageContext context, org.openflow.protocol.OFMessage m) handle the other messages.
abstract boolean	handlePacketIn(Connection conn, MessageContext context, org.openflow.protocol.OFMessage m) handle Packet-in Message.
boolean	handleReadEvent(Connection conn, java.util.List<org.openflow.protocol.OFMessage> msgs) This is a method that cannot be overridden.
abstract void	init() Every controller implementation that inherits OFController should implement this function to handle all the chores related to the controller initialization.
void	registerProtocolServer(IOFProtocolServer server) Register a protocol server that actually handles the underlying bearer protocol.
void	removeSelf() This method is called by OFController.QP.run() when a controller fails to remove itself from the protocol server, which prevents this controller from receiving other Openflow messages from the protocol server.
void	scheduleTask(IOFTask task, long after) Schedule a task to be executed after 'after'.
void	shutdown() Shutdown this OF Controller instance including all the Queue Processors
void	start() Start all Queue Processors.

Methods inherited from class java.lang.Object

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

Field Detail

timer

private java.util.Timer timer

Timer for scheduling asynchronous jobs.

switches

private java.util.concurrent.ConcurrentHashMap<java.lang.Long,IOFSwitch> switches

index to all switches.

modules

private java.util.Set<OFModule> modules

set of all modules.

role

private IOFHandler.Role role

role of this controller. (EQUAL, MASTER, SLAVE)

processors

private OFController.QP[] processors

Queue Item Processors

server

private IOFProtocolServer server

Protocol Server object, which is currently TcpServer.

protocol

private OFProtocol protocol

Constructor Detail

OFController

public OFController(int num_of_queue,
            java.lang.String role)

OFController constructor.

Parameters:

num_of_queue - number of Queue Item Processors

Method Detail

getProtocol

public OFProtocol getProtocol()

Specified by:

getProtocol in interface IOFHandler

init

public abstract void init()

Every controller implementation that inherits OFController should implement this function to handle all the chores related to the controller initialization. You can use SimpleOFController class as a reference to see what kind of initialization you should do.

getRole

public IOFHandler.Role getRole()

get the role of this controller. But currently, the return value of this function only set to MASTER.

Specified by:

getRole in interface IOFHandler

registerProtocolServer

public void registerProtocolServer(IOFProtocolServer server)

Register a protocol server that actually handles the underlying bearer protocol.

Specified by:

registerProtocolServer in interface IOFHandler

removeSelf

public void removeSelf()

This method is called by OFController.QP.run() when a controller fails to remove itself from the protocol server, which prevents this controller from receiving other Openflow messages from the protocol server.

shutdown

public void shutdown()

Shutdown this OF Controller instance including all the Queue Processors

start

public void start()

Start all Queue Processors.

scheduleTask

public void scheduleTask(IOFTask task,
                long after)

Schedule a task to be executed after 'after'. Unless the task.execute() returns false, the task periodically repeated using 'after' as a period value.

Specified by:

scheduleTask in interface IOFHandler

Parameters:

task -

after - re-schedule this task after 'after' milliseconds. If zero is given, the task will start immediately, and never be repeated.

handleConnectedEvent

public final boolean handleConnectedEvent(Connection conn)

This callback is called when a new connection to a new switch is made. Internally, the initial HELLO handshaking to the switch is made.

Specified by:

handleConnectedEvent in interface IOFHandler

handlePacketIn

public abstract boolean handlePacketIn(Connection conn,
                     MessageContext context,
                     org.openflow.protocol.OFMessage m)

handle Packet-in Message.

Parameters:

conn - underlying connection

context -

m - Packet-in message.

Returns:

returns false when the underling connection caused error.

handleGeneric

public abstract boolean handleGeneric(Connection conn,
                    MessageContext context,
                    org.openflow.protocol.OFMessage m)

handle the other messages.

Parameters:

conn - underlying connection

context -

m - message which is not packet-in, hello, or echo request message.

Returns:

returns false when the underling connection caused error.

handleReadEvent

public final boolean handleReadEvent(Connection conn,
                      java.util.List<org.openflow.protocol.OFMessage> msgs)

This is a method that cannot be overridden. This is an internal method only called by ClientChannelWatcher object.

Specified by:

handleReadEvent in interface IOFHandler

getSwitchIdentifiers

public final java.util.Set<java.lang.Long> getSwitchIdentifiers()

return the set of all switch identifiers

Specified by:

getSwitchIdentifiers in interface IOFHandler

Returns:

this function returns a hashset object.

getSwitches

public final java.util.Collection<IOFSwitch> getSwitches()

return the set of all switches

Specified by:

getSwitches in interface IOFHandler

getSwitch

public final IOFSwitch getSwitch(long id)

return a specific switch with a given identifier

Specified by:

getSwitch in interface IOFHandler

addSwitch

public void addSwitch(long id,
             IOFSwitch sw)

Specified by:

addSwitch in interface IOFHandler

handleDisconnectEvent

public final boolean handleDisconnectEvent(Connection conn)

This callback is called when a connection to a switch is lost.

Specified by:

handleDisconnectEvent in interface IOFHandler

addModule

public final void addModule(OFModule module)

This method is automatically called by OFModule.init(IOFHandler). This method is for adding a module as a part of this controller object.

Specified by:

addModule in interface IOFHandler

compareTo

public final int compareTo(IOFHandler o)

Specified by:

compareTo in interface java.lang.Comparable<IOFHandler>

getModels

public final OFModel[] getModels()

This method returns all the OFModel object which are associated with this controller. As an OFModel object is normally associated with a OFModule object, this method calls OFModule.getModels() method of each OFModule object in modules.

Specified by:

getModels in interface IOFHandler

getConcatenatedModuleNames

public final java.lang.String getConcatenatedModuleNames()

get a String representation of all module names linked with ','.

Specified by:

getConcatenatedModuleNames in interface IOFHandler

getModules

public final java.util.Collection<OFModule> getModules()

get all the OFModule objects associated with this controller.

Specified by:

getModules in interface IOFHandler

getModuleNames

public final java.lang.String[] getModuleNames()

get an array that holds all the module names associated with this controller.

Specified by:

getModuleNames in interface IOFHandler