inet::InterfaceOperationBase Class Reference

Base class for lifecycle operations that manipulate a network interface. More...

#include <InterfaceOperations.h>

Inheritance diagram for inet::InterfaceOperationBase:

Public Types
enum	Stage { STAGE_LOCAL, STAGE_LAST }
Public Types inherited from inet::LifecycleOperation
typedef std::map< std::string, std::string >	StringMap

Public Member Functions
	InterfaceOperationBase ()
virtual void	initialize (cModule *module, StringMap &params)
	Initialize the operation using the parameters provided in the string map. More...
virtual int	getNumStages () const
	Returns the number of stages required by this operation. More...
NetworkInterface *	getInterface () const
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...

Private Attributes
NetworkInterface *	ie

Detailed Description

Base class for lifecycle operations that manipulate a network interface.

Member Enumeration Documentation

Stage

enum inet::InterfaceOperationBase::Stage

Enumerator
STAGE_LOCAL
STAGE_LAST

{ STAGE_LOCAL, STAGE_LAST };

Constructor & Destructor Documentation

InterfaceOperationBase()

inet::InterfaceOperationBase::InterfaceOperationBase ( )

inline

: ie(nullptr) {}

Member Function Documentation

getInterface()

NetworkInterface* inet::InterfaceOperationBase::getInterface ( ) const

inline

{ return ie; }

getNumStages()

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

inlinevirtual

Returns the number of stages required by this operation.

Implements inet::LifecycleOperation.

{ return STAGE_LAST + 1; }

initialize()

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

virtual

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 from inet::LifecycleOperation.

{
    if (!isNetworkNode(module))
        throw cRuntimeError("Interface operations may only be applied to network nodes (host, router, etc.)");
 
    LifecycleOperation::initialize(module, params);
 
    // note: these operations cannot be generic, because their ctor requires NetworkInterface as parameter
    IInterfaceTable *ift = L3AddressResolver().findInterfaceTableOf(module);
    if (!ift)
        throw cRuntimeError("Interface table of network node '%s' not found, required for operation %s", module->getFullPath().c_str(), getClassName());
    std::string interfaceName = params["interfacename"];
    params.erase("interfacename"); // TODO implement "towards=..."
    if (interfaceName.empty())
        throw cRuntimeError("interfacename attribute missing, required for operation %s", getClassName());
    NetworkInterface *ie = ift->findInterfaceByName(interfaceName.c_str());
    if (!ie)
        throw cRuntimeError("No interface named '%s', required for operation %s", interfaceName.c_str(), getClassName());
}

Member Data Documentation

ie

NetworkInterface* inet::InterfaceOperationBase::ie

private

Referenced by initialize().

---

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

• InterfaceOperations.h
• InterfaceOperations.cc