inet::OperationalBase Class Reference

#include <OperationalBase.h>

Inheritance diagram for inet::OperationalBase:

Public Member Functions
	OperationalBase ()
Public Member Functions inherited from inet::ILifecycle
virtual	~ILifecycle ()

Protected Member Functions
virtual int	numInitStages () const override
virtual void	initialize (int stage) override
virtual void	handleMessage (cMessage *msg) override
virtual void	handleMessageWhenDown (cMessage *msg)
virtual void	handleMessageWhenUp (cMessage *msg)=0
virtual bool	handleOperationStage (LifecycleOperation *operation, int stage, IDoneCallback *doneCallback) override
	Perform one stage of a lifecycle operation. More...
virtual bool	handleNodeStart (IDoneCallback *doneCallback)
virtual bool	handleNodeShutdown (IDoneCallback *doneCallback)
virtual void	handleNodeCrash ()
virtual bool	isInitializeStage (int stage)=0
virtual bool	isNodeStartStage (int stage)=0
virtual bool	isNodeShutdownStage (int stage)=0
virtual void	setOperational (bool isOperational)

Protected Attributes
bool	isOperational
simtime_t	lastChange

Constructor & Destructor Documentation

inet::OperationalBase::OperationalBase

(

)

                                 :
    isOperational(false)
{
}

Member Function Documentation

void inet::OperationalBase::handleMessage ( cMessage *  msg )

overrideprotectedvirtual

{
    if (isOperational)
        handleMessageWhenUp(message);
    else
        handleMessageWhenDown(message);
}

void inet::OperationalBase::handleMessageWhenDown ( cMessage *  msg )

protectedvirtual

Reimplemented in inet::physicallayer::Radio.

Referenced by handleMessage(), and inet::physicallayer::Radio::handleMessageWhenDown().

{
    if (message->isSelfMessage())
        throw cRuntimeError("Self message '%s' received when %s is down", message->getName(), getComponentType()->getName());
    else if (simTime() == lastChange)
        EV_WARN << getComponentType()->getName() << " is down, dropping '" << message->getName() << "' message\n";
    else
        throw cRuntimeError("Message '%s' received when %s is down", message->getName(), getComponentType()->getName());
    delete message;
}

virtual void inet::OperationalBase::handleMessageWhenUp ( cMessage *  msg )

protectedpure virtual

Implemented in inet::PIMDM, inet::PIMSM, inet::physicallayer::Radio, inet::UDPBasicBurst, inet::UDPVideoStreamSvr, inet::UDPBasicApp, inet::UDPSink, inet::UDPVideoStreamCli, inet::UDPEchoApp, and inet::LayeredProtocolBase.

Referenced by handleMessage().

void inet::OperationalBase::handleNodeCrash ( )

protectedvirtual

Reimplemented in inet::PIMDM, inet::PIMSM, inet::PIMBase, inet::physicallayer::Radio, inet::UDPBasicBurst, inet::ieee80211::Ieee80211Mac, inet::UDPVideoStreamSvr, inet::UDPBasicApp, inet::UDPSink, inet::UDPVideoStreamCli, and inet::UDPEchoApp.

Referenced by inet::physicallayer::Radio::handleNodeCrash(), and handleOperationStage().

{
}

bool inet::OperationalBase::handleNodeShutdown ( IDoneCallback *  doneCallback )

protectedvirtual

Reimplemented in inet::PIMDM, inet::PIMSM, inet::PIMBase, inet::physicallayer::Radio, inet::UDPBasicBurst, inet::ieee80211::Ieee80211Mac, inet::UDPVideoStreamSvr, inet::UDPBasicApp, inet::UDPSink, inet::UDPVideoStreamCli, and inet::UDPEchoApp.

Referenced by inet::physicallayer::Radio::handleNodeShutdown(), and handleOperationStage().

{
    return true;
}

bool inet::OperationalBase::handleNodeStart ( IDoneCallback *  doneCallback )

protectedvirtual

Reimplemented in inet::PIMDM, inet::PIMSM, inet::PIMBase, inet::physicallayer::Radio, inet::UDPBasicBurst, inet::ieee80211::Ieee80211Mac, inet::UDPVideoStreamSvr, inet::UDPBasicApp, inet::UDPSink, inet::UDPVideoStreamCli, and inet::UDPEchoApp.

Referenced by inet::ieee80211::Ieee80211Mac::handleNodeShutdown(), inet::ieee80211::Ieee80211Mac::handleNodeStart(), inet::physicallayer::Radio::handleNodeStart(), handleOperationStage(), and initialize().

{
    return true;
}

bool inet::OperationalBase::handleOperationStage ( LifecycleOperation *  operation, int  stage, IDoneCallback *  doneCallback  )

overrideprotectedvirtual

Perform one stage of a lifecycle operation.

Processing may be done entirely within this method, or may be a longer process that involves nonzero simulation time or several events, and is triggered by this method call.

Return value: true = "done"; false = "not yet done, will invoke doneCallback when done"

Implements inet::ILifecycle.

{
    Enter_Method_Silent();
    if (dynamic_cast<NodeStartOperation *>(operation)) {
        if (isNodeStartStage(stage)) {
            setOperational(true);
            return handleNodeStart(doneCallback);
        }
    }
    else if (dynamic_cast<NodeShutdownOperation *>(operation)) {
        if (isNodeShutdownStage(stage)) {
            bool done = handleNodeShutdown(doneCallback);
            setOperational(false);
            return done;
        }
    }
    else if (dynamic_cast<NodeCrashOperation *>(operation)) {
        if (stage == NodeCrashOperation::STAGE_CRASH) {
            handleNodeCrash();
            setOperational(false);
            return true;
        }
    }
    return true;
}

void inet::OperationalBase::initialize ( int  stage )

overrideprotectedvirtual

Reimplemented in inet::PIMDM, inet::PIMSM, inet::PIMBase, inet::physicallayer::Radio, inet::CsmaCaMac, inet::Flood, inet::LMacLayer, inet::CSMA, inet::IdealMac, inet::UDPBasicBurst, inet::UDPVideoStreamSvr, inet::BMacLayer, inet::ieee80211::Ieee80211Mac, inet::WiseRoute, inet::ProbabilisticBroadcast, inet::UDPBasicApp, inet::UDPSink, inet::UDPVideoStreamCli, inet::MACProtocolBase, inet::physicallayer::Ieee80211Radio, inet::UDPEchoApp, inet::NetworkProtocolBase, and inet::AdaptiveProbabilisticBroadcast.

Referenced by inet::NetworkProtocolBase::initialize(), inet::UDPEchoApp::initialize(), inet::MACProtocolBase::initialize(), inet::UDPVideoStreamCli::initialize(), inet::UDPSink::initialize(), inet::UDPBasicApp::initialize(), inet::UDPVideoStreamSvr::initialize(), inet::UDPBasicBurst::initialize(), inet::physicallayer::Radio::initialize(), and inet::PIMBase::initialize().

{
    if (isInitializeStage(stage)) {
        NodeStatus *nodeStatus = dynamic_cast<NodeStatus *>(findContainingNode(this)->getSubmodule("status"));
        setOperational(!nodeStatus || nodeStatus->getState() == NodeStatus::UP);
        if (isOperational)
            handleNodeStart(nullptr);
    }
}

virtual bool inet::OperationalBase::isInitializeStage ( int  stage )

protectedpure virtual

Implemented in inet::PIMBase, inet::MACProtocolBase, inet::NetworkProtocolBase, inet::PhysicalLayerBase, inet::ApplicationBase, and inet::TransportProtocolBase.

Referenced by initialize().

virtual bool inet::OperationalBase::isNodeShutdownStage ( int  stage )

protectedpure virtual

Implemented in inet::PIMBase, inet::MACProtocolBase, inet::NetworkProtocolBase, inet::PhysicalLayerBase, inet::ApplicationBase, and inet::TransportProtocolBase.

Referenced by handleOperationStage().

virtual bool inet::OperationalBase::isNodeStartStage ( int  stage )

protectedpure virtual

Implemented in inet::PIMBase, inet::MACProtocolBase, inet::NetworkProtocolBase, inet::PhysicalLayerBase, inet::ApplicationBase, and inet::TransportProtocolBase.

Referenced by handleOperationStage().

virtual int inet::OperationalBase::numInitStages ( ) const

inlineoverrideprotectedvirtual

Reimplemented in inet::PIMDM, inet::PIMSM, inet::PIMBase, inet::Flood, inet::IdealMac, inet::UDPBasicBurst, inet::UDPVideoStreamSvr, inet::BMacLayer, inet::ieee80211::Ieee80211Mac, inet::WiseRoute, inet::ProbabilisticBroadcast, inet::UDPBasicApp, inet::UDPSink, inet::UDPVideoStreamCli, and inet::UDPEchoApp.

{ return NUM_INIT_STAGES; }

void inet::OperationalBase::setOperational ( bool  isOperational )

protectedvirtual

Referenced by handleOperationStage(), and initialize().

{
    this->isOperational = isOperational;
    lastChange = simTime();
}

Member Data Documentation

bool inet::OperationalBase::isOperational

protected

Referenced by handleMessage(), initialize(), inet::ieee80211::Ieee80211Mac::initialize(), and setOperational().

simtime_t inet::OperationalBase::lastChange

protected

Referenced by handleMessageWhenDown(), and setOperational().

---

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

• OperationalBase.h
• OperationalBase.cc