#include <OperationalMixin.h>

Inheritance diagram for inet::OperationalMixin< T >:

Classes
class	Operation

Protected Types
enum	State { STARTING_OPERATION, OPERATING, STOPPING_OPERATION, CRASHING_OPERATION, NOT_OPERATING }

Protected Member Functions
virtual int	numInitStages () const override

virtual void	initialize (int stage) override

virtual void	refreshDisplay () const override

virtual void	handleMessage (cMessage *msg) override

virtual void	handleMessageWhenDown (cMessage *msg)

virtual void	handleMessageWhenUp (cMessage *msg)=0

virtual bool	handleOperationStage (LifecycleOperation operation, IDoneCallback doneCallback) override
	Perform one stage of a lifecycle operation. More...

virtual void	handleStartOperation (LifecycleOperation *operation)=0

virtual void	handleStopOperation (LifecycleOperation *operation)=0

virtual void	handleCrashOperation (LifecycleOperation *operation)=0

virtual State	getInitialOperationalState () const
	Returns initial operational state: OPERATING or NOT_OPERATING. More...

virtual bool	isInitializeStage (int stage) const =0

virtual bool	isModuleStartStage (int stage) const =0

virtual bool	isModuleStopStage (int stage) const =0

virtual void	handleActiveOperationTimeout (cMessage *message)

Protected Attributes
State	operationalState = NOT_OPERATING

simtime_t	lastChange

Operation	activeOperation

cMessage *	activeOperationTimeout = nullptr

cMessage *	activeOperationExtraTimer = nullptr

virtual bool	isUp () const
	utility functions More...

virtual bool	isDown () const

virtual void	setOperationalState (State newState)

virtual void	scheduleOperationTimeout (simtime_t timeout)

virtual void	setupActiveOperation (LifecycleOperation operation, IDoneCallback doneCallback, State)

virtual void	delayActiveOperationFinish (simtime_t timeout)

virtual void	startActiveOperationExtraTime (simtime_t delay=SIMTIME_ZERO)

virtual void	startActiveOperationExtraTimeOrFinish (simtime_t extraTime)

virtual void	finishActiveOperation ()

virtual	~OperationalMixin ()
	}@ More...

Additional Inherited Members
Public Types inherited from inet::units::value< Value, Units >
typedef Value	value_type

typedef Units	unit

Public Member Functions inherited from inet::units::value< Value, Units >
	value ()

	value (const value_type &v)

template<typename OtherValue , typename OtherUnits >
	value (const value< OtherValue, OtherUnits > &v)

std::string	str () const

const value_type &	get () const

void	set (const value_type &v)

template<typename OtherValue , typename OtherUnits >
value &	operator= (const value< OtherValue, OtherUnits > &other)

template<typename OtherValue , typename OtherUnits , typename ResultValue = typename std::remove_cv<decltype(Value() + OtherValue())>::type>
value< ResultValue, Units >	operator+ (const value< OtherValue, OtherUnits > &other) const

template<typename OtherValue , typename OtherUnits >
value &	operator+= (const value< OtherValue, OtherUnits > &other)

template<typename OtherValue , typename OtherUnits >
value &	operator-= (const value< OtherValue, OtherUnits > &other)

template<typename OtherValue , typename OtherUnits , typename ResultValue = typename std::remove_cv<decltype(Value() - OtherValue())>::type>
value< ResultValue, Units >	operator- (const value< OtherValue, OtherUnits > &other) const

value	operator- () const

template<typename OtherValue , typename OtherUnits , typename ResultValue = typename std::remove_cv<decltype(Value() * OtherValue())>::type>
value< ResultValue, compose< Units, OtherUnits > >	operator* (const value< OtherValue, OtherUnits > &other) const

template<typename OtherValue >
value	operator* (OtherValue v) const

value &	operator*= (const value_type &v)

template<typename OtherValue , typename OtherUnits , typename ResultValue = typename std::remove_cv<decltype(Value() / OtherValue())>::type>
value< ResultValue, compose< Units, pow< OtherUnits, -1 > > >	operator/ (const value< OtherValue, OtherUnits > &other) const

value	operator/ (const value_type &v) const

value &	operator/= (const value_type &v)

template<typename OtherValue , typename OtherUnits >
bool	operator== (const value< OtherValue, OtherUnits > &other) const

template<typename OtherValue , typename OtherUnits >
bool	operator!= (const value< OtherValue, OtherUnits > &other) const

template<typename OtherValue , typename OtherUnits >
bool	operator< (const value< OtherValue, OtherUnits > &other) const

template<typename OtherValue , typename OtherUnits >
bool	operator<= (const value< OtherValue, OtherUnits > &other) const

template<typename OtherValue , typename OtherUnits >
bool	operator> (const value< OtherValue, OtherUnits > &other) const

template<typename OtherValue , typename OtherUnits >
bool	operator>= (const value< OtherValue, OtherUnits > &other) const

value &	operator++ ()

value	operator++ (int)

value &	operator-- ()

value	operator-- (int)

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

Member Enumeration Documentation

◆ State

template<typename T >

enum inet::OperationalMixin::State

protected

Enumerator
STARTING_OPERATION
OPERATING
STOPPING_OPERATION
CRASHING_OPERATION
NOT_OPERATING

                {
         STARTING_OPERATION, OPERATING, STOPPING_OPERATION, CRASHING_OPERATION, NOT_OPERATING,
         /*SUSPENDING_OPERATION, OPERATION_SUSPENDED, RESUMING_OPERATION */
     };

Constructor & Destructor Documentation

◆ ~OperationalMixin()

template<typename T >

inet::OperationalMixin< T >::~OperationalMixin

virtual

}@

 {
     T::cancelAndDelete(activeOperationExtraTimer);
     T::cancelAndDelete(activeOperationTimeout);
 }

Member Function Documentation

◆ delayActiveOperationFinish()

template<typename T >

void inet::OperationalMixin< T >::delayActiveOperationFinish ( simtime_t timeout )

protectedvirtual

 {
     ASSERT(activeOperation.operation != nullptr);
     activeOperation.delayFinish();
     scheduleOperationTimeout(timeout);
 }

◆ finishActiveOperation()

template<typename T >

void inet::OperationalMixin< T >::finishActiveOperation

protectedvirtual

 {
     setOperationalState(activeOperation.endState);
     if (activeOperation.isDelayedFinish) {
         T::cancelEvent(activeOperationExtraTimer);
         T::cancelEvent(activeOperationTimeout);
         activeOperation.doneCallback->invoke();
     }
     activeOperation.clear();
 }

◆ getInitialOperationalState()

template<typename T >

OperationalMixin< T >::State inet::OperationalMixin< T >::getInitialOperationalState

protectedvirtual

Returns initial operational state: OPERATING or NOT_OPERATING.

 {
     cModule *node = findContainingNode(this);
     NodeStatus *nodeStatus = node ? check_and_cast_nullable<NodeStatus *>(node->getSubmodule("status")) : nullptr;
     return (!nodeStatus || nodeStatus->getState() == NodeStatus::UP) ? OPERATING : NOT_OPERATING;
 }

◆ handleActiveOperationTimeout()

template<typename T >

void inet::OperationalMixin< T >::handleActiveOperationTimeout ( cMessage * message )

protectedvirtual

 {
     handleCrashOperation(activeOperation.operation);
     finishActiveOperation();
 }

◆ handleCrashOperation()

template<typename T >

virtual void inet::OperationalMixin< T >::handleCrashOperation ( LifecycleOperation * operation )

protectedpure virtual

Implemented in inet::Ieee802154Mac, inet::Ipv4, inet::RsvpTe, inet::PimDm, inet::InterfaceTable, inet::PimSm, inet::dymo::Dymo, inet::aodv::Aodv, inet::Udp, inet::CsmaCaMac, inet::tcp::Tcp, inet::PimBase, inet::NextHopForwarding, inet::physicallayer::Radio, inet::Ldp, inet::DhcpClient, inet::Gpsr, inet::EthernetMacBase, inet::Flooding, inet::ProbabilisticBroadcast, inet::Rip, inet::MacForwardingTable, inet::DhcpServer, inet::WiseRoute, inet::Arp, inet::PingApp, inet::ieee80211::Ieee80211Mac, inet::UdpBasicBurst, inet::Ted, inet::ieee80211::Ieee80211MgmtBase, inet::EthernetEncapsulation, inet::Dsdv, inet::MacProtocolBase, inet::GlobalArp, inet::EtherAppClient, inet::UdpVideoStreamServer, inet::EtherTrafGen, inet::IpvxTrafGen, inet::Ieee8021dRelay, inet::AckingMac, inet::ospfv2::Ospfv2, inet::UdpBasicApp, inet::Ieee8022Llc, inet::physicallayer::ShortcutRadio, inet::TunnelApp, inet::UdpSink, inet::Pim, inet::TcpServerHostApp, inet::StpBase, inet::TcpSessionApp, inet::PacketReceiverBase, inet::Ieee8022LlcSocketIo, inet::UdpVideoStreamClient, inet::MacRelayUnitBase, inet::TcpBasicClientApp, inet::EtherAppServer, inet::HostAutoConfigurator, inet::EthernetSocketIo, inet::TelnetApp, inet::UdpSocketIo, inet::IpvxTrafSink, inet::UdpEchoApp, inet::SimpleClockSynchronizer, inet::StreamThroughTransmitter, inet::TcpServerListener, inet::PacketTransmitter, and inet::StreamingTransmitter.

◆ handleMessage()

template<typename T >

void inet::OperationalMixin< T >::handleMessage ( cMessage * msg )

overrideprotectedvirtual

Reimplemented in inet::MacForwardingTable.

 {
     if (message == activeOperationExtraTimer)
         finishActiveOperation();
     else if (message == activeOperationTimeout) {
         T::cancelEvent(activeOperationExtraTimer);
         handleActiveOperationTimeout(message);
     }
     else {
         switch (operationalState) {
             case STARTING_OPERATION:
             case OPERATING:
             case STOPPING_OPERATION:
                 handleMessageWhenUp(message);
                 break;
             case NOT_OPERATING:
                 handleMessageWhenDown(message);
                 break;
             case CRASHING_OPERATION:
             default:
                 throw cRuntimeError("Invalid operational state: %d", (int)operationalState);
         }
     }
 }

◆ handleMessageWhenDown()

template<typename T >

void inet::OperationalMixin< T >::handleMessageWhenDown ( cMessage * msg )

protectedvirtual

Reimplemented in inet::MacProtocolBase, inet::physicallayer::Radio, and inet::PacketReceiverBase.

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

Referenced by inet::PacketReceiverBase::handleMessageWhenDown().

◆ handleMessageWhenUp()

template<typename T >

virtual void inet::OperationalMixin< T >::handleMessageWhenUp ( cMessage * msg )

protectedpure virtual

Implemented in inet::RsvpTe, inet::PimDm, inet::Ipv4, inet::PimSm, inet::Ldp, inet::NextHopForwarding, inet::aodv::Aodv, inet::Rip, inet::Arp, inet::Rstp, inet::PingApp, inet::UdpBasicBurst, inet::Dsdv, inet::Stp, inet::GlobalArp, inet::MacForwardingTable, inet::DhcpClient, inet::UdpVideoStreamServer, inet::Ted, inet::IpvxTrafGen, inet::ospfv2::Ospfv2, inet::DhcpServer, inet::EtherTrafGen, inet::EtherAppClient, inet::Pim, inet::UdpBasicApp, inet::ieee80211::Ieee80211MgmtBase, inet::UdpSink, inet::TcpAppBase, inet::TunnelApp, inet::EtherAppServer, inet::UdpVideoStreamClient, inet::EthernetCsmaMac, inet::HostAutoConfigurator, inet::TcpServerHostApp, inet::EthernetMac, inet::IpvxTrafSink, inet::SimpleClockSynchronizer, inet::UdpEchoApp, inet::TcpServerListener, inet::dymo::Dymo, inet::Gpsr, inet::ieee80211::Ieee80211Mac, inet::Ppp, inet::EthernetEncapsulation, inet::PacketTransmitterBase, inet::Ieee8022Llc, inet::physicallayer::ShortcutRadio, inet::PacketReceiverBase, inet::ShortcutMac, inet::Ieee8022LlcSocketIo, inet::StreamThroughTransmitter, inet::EthernetSocketIo, inet::UdpSocketIo, inet::LayeredProtocolBase, inet::DestreamingReceiver, inet::StreamThroughReceiver, inet::PacketReceiver, inet::PacketTransmitter, inet::StreamingTransmitter, and inet::InterfaceTable.

◆ handleOperationStage()

template<typename T >

bool inet::OperationalMixin< T >::handleOperationStage	(	LifecycleOperation *	operation,
		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("handleOperationStage");
     int stage = operation->getCurrentStage();
     if (dynamic_cast<ModuleStartOperation *>(operation)) {
         if (isModuleStartStage(stage)) {
             operationalState = STARTING_OPERATION;
             setupActiveOperation(operation, doneCallback, OPERATING);
             handleStartOperation(operation);
             if (activeOperation.operation != nullptr && !activeOperation.isDelayedFinish)
                 finishActiveOperation();
             return activeOperation.operation == nullptr;
         }
     }
     else if (dynamic_cast<ModuleStopOperation *>(operation)) {
         if (isModuleStopStage(stage)) {
             operationalState = STOPPING_OPERATION;
             setupActiveOperation(operation, doneCallback, NOT_OPERATING);
             handleStopOperation(operation);
             if (activeOperation.operation != nullptr && !activeOperation.isDelayedFinish)
                 finishActiveOperation();
             return activeOperation.operation == nullptr;
         }
     }
     else if (dynamic_cast<ModuleCrashOperation *>(operation)) {
         if (stage == ModuleCrashOperation::STAGE_CRASH) {
             operationalState = CRASHING_OPERATION;
             setupActiveOperation(operation, doneCallback, NOT_OPERATING);
             handleCrashOperation(operation);
             finishActiveOperation();
             return true;
         }
     }
     else
         throw cRuntimeError("unaccepted Lifecycle operation: (%s)%s", operation->getClassName(), operation->getName());
     return true;
 }

◆ handleStartOperation()

template<typename T >

virtual void inet::OperationalMixin< T >::handleStartOperation ( LifecycleOperation * operation )

protectedpure virtual

Implemented in inet::Ieee802154Mac, inet::Ipv4, inet::RsvpTe, inet::PimDm, inet::InterfaceTable, inet::PimSm, inet::dymo::Dymo, inet::aodv::Aodv, inet::Udp, inet::tcp::Tcp, inet::PimBase, inet::NextHopForwarding, inet::physicallayer::Radio, inet::Ldp, inet::DhcpClient, inet::Gpsr, inet::EthernetMacBase, inet::Flooding, inet::ProbabilisticBroadcast, inet::Rip, inet::MacForwardingTable, inet::DhcpServer, inet::WiseRoute, inet::Arp, inet::PingApp, inet::ieee80211::Ieee80211Mac, inet::UdpBasicBurst, inet::Ted, inet::ieee80211::Ieee80211MgmtBase, inet::EthernetEncapsulation, inet::Dsdv, inet::MacProtocolBase, inet::GlobalArp, inet::EtherAppClient, inet::UdpVideoStreamServer, inet::EtherTrafGen, inet::IpvxTrafGen, inet::Ieee8021dRelay, inet::AckingMac, inet::ospfv2::Ospfv2, inet::UdpBasicApp, inet::Ieee8022Llc, inet::physicallayer::ShortcutRadio, inet::TunnelApp, inet::UdpSink, inet::Pim, inet::PacketTransmitterBase, inet::TcpServerHostApp, inet::StpBase, inet::TcpSessionApp, inet::PacketReceiverBase, inet::Ieee8022LlcSocketIo, inet::UdpVideoStreamClient, inet::MacRelayUnitBase, inet::TcpBasicClientApp, inet::EtherAppServer, inet::HostAutoConfigurator, inet::EthernetSocketIo, inet::TelnetApp, inet::UdpSocketIo, inet::IpvxTrafSink, inet::UdpEchoApp, inet::SimpleClockSynchronizer, and inet::TcpServerListener.

◆ handleStopOperation()

template<typename T >

virtual void inet::OperationalMixin< T >::handleStopOperation ( LifecycleOperation * operation )

protectedpure virtual

Implemented in inet::Ieee802154Mac, inet::Ipv4, inet::RsvpTe, inet::PimDm, inet::InterfaceTable, inet::PimSm, inet::dymo::Dymo, inet::aodv::Aodv, inet::Udp, inet::CsmaCaMac, inet::tcp::Tcp, inet::PimBase, inet::NextHopForwarding, inet::physicallayer::Radio, inet::Ldp, inet::DhcpClient, inet::Gpsr, inet::EthernetMacBase, inet::Flooding, inet::ProbabilisticBroadcast, inet::Rip, inet::MacForwardingTable, inet::DhcpServer, inet::WiseRoute, inet::Arp, inet::PingApp, inet::ieee80211::Ieee80211Mac, inet::UdpBasicBurst, inet::Ted, inet::ieee80211::Ieee80211MgmtBase, inet::EthernetEncapsulation, inet::Dsdv, inet::MacProtocolBase, inet::GlobalArp, inet::Ppp, inet::EtherAppClient, inet::UdpVideoStreamServer, inet::EtherTrafGen, inet::IpvxTrafGen, inet::Ieee8021dRelay, inet::AckingMac, inet::ospfv2::Ospfv2, inet::UdpBasicApp, inet::Ieee8022Llc, inet::physicallayer::ShortcutRadio, inet::TunnelApp, inet::UdpSink, inet::Pim, inet::TcpServerHostApp, inet::StpBase, inet::TcpSessionApp, inet::PacketReceiverBase, inet::Ieee8022LlcSocketIo, inet::UdpVideoStreamClient, inet::MacRelayUnitBase, inet::TcpBasicClientApp, inet::EtherAppServer, inet::HostAutoConfigurator, inet::EthernetSocketIo, inet::TelnetApp, inet::UdpSocketIo, inet::IpvxTrafSink, inet::UdpEchoApp, inet::SimpleClockSynchronizer, inet::StreamThroughTransmitter, inet::TcpServerListener, inet::PacketTransmitter, and inet::StreamingTransmitter.

◆ initialize()

template<typename T >

void inet::OperationalMixin< T >::initialize ( int stage )

overrideprotectedvirtual

Reimplemented in inet::Flooding, inet::LMac, inet::WiseRoute, inet::Ieee802154Mac, inet::XMac, inet::ieee80211::Ieee80211MgmtAp, inet::BMac, inet::ieee80211::Ieee80211Mac, inet::ProbabilisticBroadcast, inet::ieee80211::Ieee80211MgmtBase, inet::AdaptiveProbabilisticBroadcast, inet::ieee80211::Ieee80211MgmtApBase, inet::ieee80211::Ieee80211MgmtStaSimplified, inet::ieee80211::Ieee80211MgmtAdhoc, inet::RsvpTe, inet::PimDm, inet::Ipv4, inet::PimSm, inet::Udp, inet::Ldp, inet::PimBase, inet::EthernetMacBase, inet::NextHopForwarding, inet::physicallayer::Radio, inet::tcp::Tcp, inet::aodv::Aodv, inet::Rip, inet::CsmaCaMac, inet::ieee80211::Ieee80211MgmtSta, inet::InterfaceTable, inet::Arp, inet::dymo::Dymo, inet::PingApp, inet::UdpBasicBurst, inet::Dsdv, inet::AckingMac, inet::Stp, inet::Gpsr, inet::GlobalArp, inet::Ppp, inet::MacForwardingTable, inet::DhcpClient, inet::UdpVideoStreamServer, inet::EthernetEncapsulation, inet::Ted, inet::IpvxTrafGen, inet::ospfv2::Ospfv2, inet::DhcpServer, inet::StpBase, inet::EtherTrafGen, inet::EtherAppClient, inet::Ieee8021dRelay, inet::Rstp, inet::TcpSessionApp, inet::Pim, inet::UdpBasicApp, inet::MacProtocolBase, inet::NetworkProtocolBase, inet::PacketTransmitterBase, inet::UdpSink, inet::Ieee8022Llc, inet::TunnelApp, inet::TcpAppBase, inet::physicallayer::Ieee80211Radio, inet::PacketReceiverBase, inet::Loopback, inet::EtherAppServer, inet::UdpVideoStreamClient, inet::physicallayer::ShortcutRadio, inet::Ieee8022LlcSocketIo, inet::TcpBasicClientApp, inet::TcpEchoApp, inet::TcpServerHostApp, inet::EthernetCsmaMac, inet::ShortcutMac, inet::HostAutoConfigurator, inet::IpvxTrafSink, inet::MacRelayUnitBase, inet::EthernetMac, inet::StreamThroughTransmitter, inet::SimpleClockSynchronizer, inet::TelnetApp, inet::TcpSinkApp, inet::physicallayer::PhysicalLayerBase, inet::EthernetSocketIo, inet::UdpEchoApp, inet::UdpSocketIo, inet::Tun, inet::physicallayer::ApskRadio, inet::StreamingReceiverBase, inet::StreamingTransmitterBase, inet::DestreamingReceiver, and inet::StreamThroughReceiver.

 {
     T::initialize(stage);
     if (stage == INITSTAGE_LOCAL) {
         WATCH(operationalState);
         activeOperationTimeout = new cMessage("ActiveOperationTimeout");
         activeOperationExtraTimer = new cMessage("ActiveOperationExtraTimer");
         activeOperationExtraTimer->setSchedulingPriority(std::numeric_limits<short>::max());
     }
     if (isInitializeStage(stage)) {
         auto state = getInitialOperationalState();
         ASSERT(state == NOT_OPERATING || state == OPERATING);
         setOperationalState(state);
         if (operationalState == OPERATING)
             handleStartOperation(nullptr); // TODO use an InitializeOperation with current stage value
     }
 }

Referenced by inet::PacketReceiverBase::initialize().

◆ isDown()

template<typename T >

virtual bool inet::OperationalMixin< T >::isDown ( ) const

inlineprotectedvirtual

67 { return operationalState == NOT_OPERATING /* || operationalState == OPERATION_SUSPENDED */; }

◆ isInitializeStage()

template<typename T >

virtual bool inet::OperationalMixin< T >::isInitializeStage ( int stage ) const

protectedpure virtual

◆ isModuleStartStage()

template<typename T >

virtual bool inet::OperationalMixin< T >::isModuleStartStage ( int stage ) const

protectedpure virtual

◆ isModuleStopStage()

template<typename T >

virtual bool inet::OperationalMixin< T >::isModuleStopStage ( int stage ) const

protectedpure virtual

◆ isUp()

template<typename T >

virtual bool inet::OperationalMixin< T >::isUp ( ) const

inlineprotectedvirtual

utility functions

66 { return operationalState != NOT_OPERATING /* && operationalState != OPERATION_SUSPENDED */; }

◆ numInitStages()

template<typename T >

virtual int inet::OperationalMixin< T >::numInitStages ( ) const

inlineoverrideprotectedvirtual

41 { return NUM_INIT_STAGES; }

◆ refreshDisplay()

template<typename T >

void inet::OperationalMixin< T >::refreshDisplay

overrideprotectedvirtual

 {
     auto& displayString = T::getDisplayString();
     switch (operationalState) {
         case STARTING_OPERATION:
             displayString.setTagArg("i2", 0, "status/up");
             break;
         case OPERATING:
             displayString.removeTag("i2");
             break;
         case STOPPING_OPERATION:
         case CRASHING_OPERATION:
             displayString.setTagArg("i2", 0, "status/down");
             break;
         case NOT_OPERATING:
             displayString.setTagArg("i2", 0, "status/cross");
             break;
         default:
             break;
     }
 }

◆ scheduleOperationTimeout()

template<typename T >

void inet::OperationalMixin< T >::scheduleOperationTimeout ( simtime_t timeout )

protectedvirtual

 {
     ASSERT(activeOperation.isDelayedFinish);
     ASSERT(!activeOperationTimeout->isScheduled());
     activeOperationTimeout->setContextPointer(activeOperation.operation);
     T::scheduleAt(simTime() + timeout, activeOperationTimeout);
     // TODO schedule timer and use module parameter
 }

◆ setOperationalState()

template<typename T >

void inet::OperationalMixin< T >::setOperationalState ( State newState )

protectedvirtual

 {
     operationalState = newState;
     lastChange = simTime();
 }

◆ setupActiveOperation()

template<typename T >

void inet::OperationalMixin< T >::setupActiveOperation	(	LifecycleOperation *	operation,
		IDoneCallback *	doneCallback,
		State	endState
	)

protectedvirtual

 {
     ASSERT(activeOperation.operation == nullptr);
     activeOperation.set(operation, doneCallback, endState);
 }

◆ startActiveOperationExtraTime()

template<typename T >

void inet::OperationalMixin< T >::startActiveOperationExtraTime ( simtime_t delay = SIMTIME_ZERO )

protectedvirtual

 {
     ASSERT(extraTime >= SIMTIME_ZERO);
     ASSERT(!activeOperationExtraTimer->isScheduled());
     activeOperation.delayFinish();
     setOperationalState(activeOperation.endState);
     T::scheduleAt(simTime() + extraTime, activeOperationExtraTimer);
 }

◆ startActiveOperationExtraTimeOrFinish()

template<typename T >

void inet::OperationalMixin< T >::startActiveOperationExtraTimeOrFinish ( simtime_t extraTime )

protectedvirtual

 {
     if (extraTime >= SIMTIME_ZERO)
         startActiveOperationExtraTime(extraTime);
     else
         finishActiveOperation();
 }

Member Data Documentation

◆ activeOperation

template<typename T >

Operation inet::OperationalMixin< T >::activeOperation

protected

◆ activeOperationExtraTimer

template<typename T >

cMessage* inet::OperationalMixin< T >::activeOperationExtraTimer = nullptr

protected

◆ activeOperationTimeout

template<typename T >

cMessage* inet::OperationalMixin< T >::activeOperationTimeout = nullptr

protected

◆ lastChange

template<typename T >

simtime_t inet::OperationalMixin< T >::lastChange

protected

◆ operationalState

template<typename T >

State inet::OperationalMixin< T >::operationalState = NOT_OPERATING

protected

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

Classes

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ State

Constructor & Destructor Documentation

◆ ~OperationalMixin()

Member Function Documentation

◆ delayActiveOperationFinish()

◆ finishActiveOperation()

◆ getInitialOperationalState()

◆ handleActiveOperationTimeout()

◆ handleCrashOperation()

◆ handleMessage()

◆ handleMessageWhenDown()

◆ handleMessageWhenUp()

◆ handleOperationStage()

◆ handleStartOperation()

◆ handleStopOperation()

◆ initialize()

◆ isDown()

◆ isInitializeStage()

◆ isModuleStartStage()

◆ isModuleStopStage()

◆ isUp()

◆ numInitStages()

◆ refreshDisplay()

◆ scheduleOperationTimeout()

◆ setOperationalState()

◆ setupActiveOperation()

◆ startActiveOperationExtraTime()

◆ startActiveOperationExtraTimeOrFinish()

Member Data Documentation

◆ activeOperation

◆ activeOperationExtraTimer

◆ activeOperationTimeout

◆ lastChange

◆ operationalState