ZeroSDN Controller  1.0
A modular distributed Software-Defined Network Controller
 All Classes Files Functions Variables Enumerations Enumerator Friends Macros
Public Member Functions | Protected Member Functions | List of all members
ExampleModuleA Class Reference

#include <ExampleModuleA.hpp>

Inheritance diagram for ExampleModuleA:

Public Member Functions

 ExampleModuleA (uint64_t instanceId)
 
 ~ExampleModuleA ()
 
virtual std::vector
< zmf::ModuleDependency > 		getDependencies ()
 
virtual zmf::data::ModuleUniqueId getUniqueId ()
 
virtual uint16_t getVersion ()
 
virtual void handleModuleStateChange (std::shared_ptr< zmf::data::ModuleHandle > changedModule, zmf::data::ModuleState newState, zmf::data::ModuleState lastState) override
 
virtual zmf::data::ZmfOutReply handleRequest (const zmf::data::ZmfMessage &message, const zmf::data::ModuleUniqueId &sender) override
 
virtual std::string getModuleName ()
 
virtual void disable ()
 

Protected Member Functions

virtual bool enable ()
 

Constructor & Destructor Documentation

ExampleModuleA::ExampleModuleA ( uint64_t  instanceId)
ExampleModuleA::~ExampleModuleA ( )

Member Function Documentation

void ExampleModuleA::disable ( )
virtual

Called when the module should disable itself. Must stop the module (threads etc.).

bool ExampleModuleA::enable ( )
protectedvirtual

Called when the module should enable itself. Must initialize and start the module.

Returns
True if enable successful, False if enable failed or rejected
std::vector< zmf::ModuleDependency > ExampleModuleA::getDependencies ( )
virtual
std::string ExampleModuleA::getModuleName ( )
virtual
zmf::data::ModuleUniqueId ExampleModuleA::getUniqueId ( )
virtual
uint16_t ExampleModuleA::getVersion ( )
virtual
void ExampleModuleA::handleModuleStateChange ( std::shared_ptr< zmf::data::ModuleHandle >  changedModule,
zmf::data::ModuleState  newState,
zmf::data::ModuleState  lastState 
)
overridevirtual

Optional: Handle state changes of other modules

zmf::data::ZmfOutReply ExampleModuleA::handleRequest ( const zmf::data::ZmfMessage &  message,
const zmf::data::ModuleUniqueId &  sender 
)
overridevirtual

Optional: Handle incoming ZMQ requests from other modules

Returns
Response message if we want to respond on the request, nullptr otherwise
The documentation for this class was generated from the following files: