Changes between Version 5 and Version 6 of Internal/OpenFlow/Controllers/FloodLight

Timestamp:

May 12, 2012, 10:47:01 PM (12 years ago)

Author:

akoshibe

Comment:

—

Internal/OpenFlow/Controllers/FloodLight

@@ -40 +40 @@
  * Click Run->Run Configurations
  * Right Click Java Application->New
- * For Name use FloodlightLaunch
+ * For Name use '!FloodlightLaunch'
  * For Project use Floodlight
  * For Main use net.floodlightcontroller.core.Main
@@ -50 +50 @@
 == Adding functionality. == #modding
 A base tutorial can be found [http://floodlight.openflowhub.org/developing-floodlight/ here]. The steps assume that you are using Eclipse. The rough steps are the following:
- 1. Create a new class under src/main/java, basing it off of a template, if it exists 
- 2. Register the module so that it is loaded at startup. This involves adding the fully qualified module name to two files:
+ 1. Create a new class under src/main/java, with the proper interfaces. 
+ 1. Export services if it interacts with other services e.g. the REST API. 
+ 1. Register the module so that it is loaded at startup. This involves adding the fully qualified module name to two files:
   * ''' net.floodlight.core.module.IFloodlightModule ''' - list of modules recognized by the loader
   * ''' floodlightdefault.properties ''' - list of modules to be loaded at startup.
+
+=== Some module components ===
+ * IFloodlightProviderService : Needed for listening to !OpenFlow messages by registering with the !FloodlightProvider.
+ * getModuleDependencies() : in a module, the function to indicate dependencies to the module loader e.g the IFloodlightProviderService above. This is probably the function that is called by the loader when it searches for loadable modules and tries to discern its dependencies. 
+ * getModuleServices() : in a module, the function to indicate services exported by the module. 
+ * getServiceImpls() : 
+ * init() : in a module, the function where contexts are defined for services that the module is dependent on. It seems to be similar to a constructor. 
+ * isCallbackOrderingPrereq(), isCallbackOrderingPostreq() : where the module should be in the message processing chain.
+ * startUp() : in a module, defines external initializations associated with other modules to which it is dependent on.
+ * receive() : defines what a module does when it receives an event e.g. the one specified in startUp().   
+
+=== Exporting services ===
+ 1. create a interface for the service
+ 1. Add interface to the module
+ 1. add classes used by the service e.g. the REST API
 
 == Architecture == #arch
@@ -62 +78 @@
 The secondary modules register with the core module when the controller is starting up. They do everything from recording certain aspects of flows to providing a RESTful API to modifying the flow tables within switches. They may also export services to leverage other modules, such as the REST API. 
 
-=== Some module components ===
- * IFloodlightProviderService : Needed for listening to !OpenFlow messages by registering with the !FloodlightProvider.
- * getModuleDependencies() : in a module, the function to indicate dependencies to the module loader e.g the IFloodlightProviderService above.
- * init() : in a module, the function where contexts are defined for services that the module is dependent on. It seems to be similar to a constructor. 
- * isCallbackOrderingPrereq(), isCallbackOrderingPostreq() : where the module should be in the message processing chain.
- * startUp() : in a module, defines external initializations associated with other modules to which it is dependent on.
- * receive() : defines what a module does when it receives an event e.g. the one specified in startUp().   
 
 = The Floodlight VM = #vm