INET Framework for OMNeT++/OMNEST
inet::NodeShutdownOperation Class Reference

This operation represents the process of orderly shutting down a network node. More...

#include <NodeOperations.h>

Inheritance diagram for inet::NodeShutdownOperation:
inet::NodeOperation inet::LifecycleOperation

Public Types

enum  Stage {
  STAGE_LOCAL, STAGE_APPLICATION_LAYER, STAGE_ROUTING_PROTOCOLS, STAGE_TRANSPORT_LAYER,
  STAGE_NETWORK_LAYER, STAGE_LINK_LAYER, STAGE_PHYSICAL_LAYER, STAGE_LAST
}
 
- Public Types inherited from inet::LifecycleOperation
enum  Kind { UP, DOWN, MOMENTARY }
 
typedef std::map< std::string, std::string > StringMap
 

Public Member Functions

virtual int getNumStages () const override
 Returns the number of stages required by this operation. More...
 
virtual Kind getKind () const override
 Returns the "kind" or "direction" of the operation. More...
 
- Public Member Functions inherited from inet::NodeOperation
virtual void initialize (cModule *module, StringMap &params) override
 Initialize the operation using the parameters provided in the string map. More...
 
- Public Member Functions inherited from inet::LifecycleOperation
 LifecycleOperation ()
 
cModule * getRootModule () const
 Returns the module the operation is initiated on. More...
 
int getCurrentStage () const
 Returns the current stage, an integer in 0..numStages-1. More...
 

Detailed Description

This operation represents the process of orderly shutting down a network node.

The operation should be applied to the module of a network node. Operation stages are organized top-down similarly to the OSI network layers.

Member Enumeration Documentation

Enumerator
STAGE_LOCAL 
STAGE_APPLICATION_LAYER 
STAGE_ROUTING_PROTOCOLS 
STAGE_TRANSPORT_LAYER 
STAGE_NETWORK_LAYER 
STAGE_LINK_LAYER 
STAGE_PHYSICAL_LAYER 
STAGE_LAST 
71  {
72  STAGE_LOCAL, // for changes that don't depend on other modules
79  STAGE_LAST // for changes that others shouldn't depend on
80  };
Definition: NodeOperations.h:72
Definition: NodeOperations.h:79
Definition: NodeOperations.h:77

Member Function Documentation

virtual Kind inet::NodeShutdownOperation::getKind ( ) const
inlineoverridevirtual

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

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

Implements inet::LifecycleOperation.

84 { return DOWN; }
Shutdown, suspend, stop, crash, interface down, etc.
Definition: LifecycleOperation.h:41
virtual int inet::NodeShutdownOperation::getNumStages ( ) const
inlineoverridevirtual

Returns the number of stages required by this operation.

Implements inet::LifecycleOperation.

83 { return STAGE_LAST + 1; }
Definition: NodeOperations.h:79

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