Base class for operations used by the ILifecycle interface. More...

#include <LifecycleOperation.h>

Inheritance diagram for inet::LifecycleOperation:

Public Types
typedef std::map< std::string, std::string >	StringMap

Public Member Functions
	LifecycleOperation ()

virtual void	initialize (cModule *module, StringMap &params)
	Initialize the operation using the parameters provided in the string map. More...

cModule *	getRootModule () const
	Returns the module the operation is initiated on. More...

virtual int	getNumStages () const =0
	Returns the number of stages required by this operation. More...

int	getCurrentStage () const
	Returns the current stage, an integer in 0..numStages-1. More...

Private Attributes
cModule *	rootModule = nullptr

int	currentStage = 0

std::vector< IDoneCallback * >	pendingList

bool	insideInitiateOperation = false

IDoneCallback *	operationCompletionCallback = nullptr

Friends
class	LifecycleController

Detailed Description

Base class for operations used by the ILifecycle interface.

Subclasses represent "operations" like shutdown, suspend, failure, restart, etc.

See also: LifecycleController, ILifecycle

Member Typedef Documentation

◆ StringMap

typedef std::map<std::string, std::string> inet::LifecycleOperation::StringMap

Constructor & Destructor Documentation

◆ LifecycleOperation()

inet::LifecycleOperation::LifecycleOperation ( )

inline

38 :

39 rootModule(nullptr), currentStage(0), insideInitiateOperation(false), operationCompletionCallback(nullptr) {}

Member Function Documentation

◆ getCurrentStage()

int inet::LifecycleOperation::getCurrentStage ( ) const

inline

Returns the current stage, an integer in 0..numStages-1.

70 { return currentStage; }

Referenced by inet::L2NodeConfigurator::handleOperationStage(), inet::Ipv4NodeConfigurator::handleOperationStage(), inet::NodeStatus::handleOperationStage(), inet::OperationalMixin< cSimpleModule >::handleOperationStage(), inet::Ipv4RoutingTable::handleOperationStage(), inet::Ipv6RoutingTable::handleOperationStage(), and inet::NetworkInterface::handleOperationStage().

◆ getNumStages()

virtual int inet::LifecycleOperation::getNumStages ( ) const

pure virtual

Returns the number of stages required by this operation.

Implemented in inet::ModuleCrashOperation, inet::ModuleStopOperation, inet::ModuleStartOperation, inet::InterfaceOperationBase, and inet::ApplicationOperationBase.

Referenced by inet::NodeStatus::handleOperationStage(), and inet::LifecycleController::resumeOperation().

◆ getRootModule()

cModule* inet::LifecycleOperation::getRootModule ( ) const

inline

Returns the module the operation is initiated on.

60 { return rootModule; }

◆ initialize()

virtual void inet::LifecycleOperation::initialize	(	cModule *	module,
		StringMap &	params
	)

inlinevirtual

Initialize the operation using the parameters provided in the string map.

The implementation should destructively modify the map, removing from it the parameters it understands. Ideally, the map should be empty when this method returns; if it is not, the caller should treat that as an error, and report the remaining parameters as unrecognized by the operation.

Reimplemented in inet::InterfaceOperationBase, and inet::ApplicationOperationBase.

                                                                 {
         cProperties *props = module->getProperties();
         if (props && (props->getAsBool("networkNode") || props->getAsBool("lifecycleSupport")))
             rootModule = module;
         else
             throw cRuntimeError("LifecycleOperation not accepted directly by '(%s)%s' module", module->getClassName(), module->getFullPath().c_str());
     }