inet::LifecycleOperation Class Reference

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

#include <LifecycleOperation.h>

Inheritance diagram for inet::LifecycleOperation:

Public Types
enum	Kind { UP, DOWN, MOMENTARY }
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...
virtual Kind	getKind () const =0
	Returns the "kind" or "direction" of the operation. 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
int	currentStage
std::vector< IDoneCallback * >	pendingList
bool	insideInitiateOperation
IDoneCallback *	operationCompletionCallback

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

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

Member Enumeration Documentation

enum inet::LifecycleOperation::Kind

Enumerator
UP	Start, boot, resume, recover, interface up, etc.
DOWN	Shutdown, suspend, stop, crash, interface down, etc.
MOMENTARY	Some kind of incident, e.g. corruption of a memory cell.

              {
        UP,    
        DOWN,    
        MOMENTARY    
    };

Constructor & Destructor Documentation

inet::LifecycleOperation::LifecycleOperation ( )

inline

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

Member Function Documentation

int inet::LifecycleOperation::getCurrentStage ( ) const

inline

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

{ return currentStage; }

virtual Kind inet::LifecycleOperation::getKind ( ) const

pure virtual

Returns the "kind" or "direction" of the operation.

This attribute is provided for convenience, it is not used by the lifecycle infrastructure itself.

Implemented in inet::NodeCrashOperation, inet::NodeShutdownOperation, and inet::NodeStartOperation.

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

pure virtual

Returns the number of stages required by this operation.

Implemented in inet::NodeCrashOperation, inet::NodeShutdownOperation, and inet::NodeStartOperation.

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

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

inline

Returns the module the operation is initiated on.

{ return rootModule; }

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::NodeOperation.

Referenced by inet::NodeOperation::initialize(), and inet::LifecycleController::processCommand().

{ rootModule = module; }

Friends And Related Function Documentation

friend class LifecycleController

friend

Member Data Documentation

int inet::LifecycleOperation::currentStage

private

Referenced by inet::LifecycleController::doOneStage(), inet::LifecycleController::initiateOperation(), inet::LifecycleController::moduleOperationStageCompleted(), and inet::LifecycleController::resumeOperation().

bool inet::LifecycleOperation::insideInitiateOperation

private

Referenced by inet::LifecycleController::initiateOperation(), inet::LifecycleController::moduleOperationStageCompleted(), and inet::LifecycleController::resumeOperation().

IDoneCallback* inet::LifecycleOperation::operationCompletionCallback

private

Referenced by inet::LifecycleController::initiateOperation(), and inet::LifecycleController::resumeOperation().

std::vector<IDoneCallback *> inet::LifecycleOperation::pendingList

private

Referenced by inet::LifecycleController::doOneStage(), inet::LifecycleController::moduleOperationStageCompleted(), and inet::LifecycleController::resumeOperation().

cModule* inet::LifecycleOperation::rootModule

private

Referenced by inet::LifecycleController::resumeOperation().

---

The documentation for this class was generated from the following file:

• LifecycleOperation.h