inet::MACBase Class Reference

Base class for MAC modules. More...

#include <MACBase.h>

Inheritance diagram for inet::MACBase:

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

Protected Member Functions
virtual void	initialize (int stage) override
virtual int	numInitStages () const override
void	registerInterface ()
virtual void	receiveSignal (cComponent *source, simsignal_t signalID, cObject *obj, cObject *details) override
virtual bool	handleOperationStage (LifecycleOperation *operation, int stage, IDoneCallback *doneCallback) override
	Perform one stage of a lifecycle operation. More...
virtual void	updateOperationalFlag (bool isNodeUp)
virtual bool	isNodeUp ()
virtual void	handleMessageWhenDown (cMessage *msg)
virtual InterfaceEntry *	createInterfaceEntry ()=0
	should create InterfaceEntry More...
virtual void	flushQueue ()=0
	should clear queue and emit signal "dropPkFromHLIfaceDown" with entire packets More...
virtual void	clearQueue ()=0
	should clear queue silently More...
virtual bool	isUpperMsg (cMessage *msg)=0
	should return true if the msg arrived from upper layer, else return false More...

Protected Attributes
cModule *	hostModule = nullptr
bool	isOperational = false
InterfaceEntry *	interfaceEntry = nullptr

Detailed Description

Base class for MAC modules.

Constructor & Destructor Documentation

inet::MACBase::MACBase ( )

inline

{}

inet::MACBase::~MACBase ( )

virtual

{
}

Member Function Documentation

virtual void inet::MACBase::clearQueue ( )

protectedpure virtual

should clear queue silently

Implemented in inet::EtherMACBase, inet::PPP, inet::ExtInterface, inet::Loopback, and inet::TunInterface.

Referenced by handleOperationStage().

virtual InterfaceEntry* inet::MACBase::createInterfaceEntry ( )

protectedpure virtual

should create InterfaceEntry

Implemented in inet::EtherMACBase, inet::PPP, inet::ExtInterface, inet::Loopback, and inet::TunInterface.

Referenced by registerInterface().

virtual void inet::MACBase::flushQueue ( )

protectedpure virtual

should clear queue and emit signal "dropPkFromHLIfaceDown" with entire packets

Implemented in inet::EtherMACBase, inet::PPP, inet::ExtInterface, inet::Loopback, and inet::TunInterface.

Referenced by handleOperationStage().

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

protectedvirtual

Referenced by inet::EtherMACFullDuplex::handleMessage(), inet::EtherMAC::handleMessage(), inet::Loopback::handleMessage(), inet::ExtInterface::handleMessage(), and inet::PPP::handleMessage().

{
    if (isUpperMsg(msg) || msg->isSelfMessage()) {    //FIXME remove 1st part -- it is not possible to ensure that no msg is sent by upper layer (race condition!!!)
        throw cRuntimeError("Message received from higher layer while interface is off");
    }
    else {
        EV << "Interface is turned off, dropping packet\n";
        delete msg;
    }
}

bool inet::MACBase::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.

Reimplemented in inet::EtherMACBase.

Referenced by inet::EtherMACBase::handleOperationStage().

{
    Enter_Method_Silent();

    if (dynamic_cast<NodeStartOperation *>(operation)) {
        if ((NodeStartOperation::Stage)stage == NodeStartOperation::STAGE_LINK_LAYER) {
            updateOperationalFlag(true);
        }
    }
    else if (dynamic_cast<NodeShutdownOperation *>(operation)) {
        if ((NodeShutdownOperation::Stage)stage == NodeShutdownOperation::STAGE_LINK_LAYER) {
            updateOperationalFlag(false);
            flushQueue();
        }
    }
    else if (dynamic_cast<NodeCrashOperation *>(operation)) {
        if ((NodeCrashOperation::Stage)stage == NodeCrashOperation::STAGE_CRASH) {
            updateOperationalFlag(false);
            clearQueue();
        }
    }
    else {
        throw cRuntimeError("Unsupported operation '%s'", operation->getClassName());
    }

    return true;
}

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

overrideprotectedvirtual

Reimplemented in inet::EtherMACBase, inet::PPP, inet::ExtInterface, inet::Loopback, inet::TunInterface, inet::EtherMAC, and inet::EtherMACFullDuplex.

Referenced by inet::TunInterface::initialize(), inet::Loopback::initialize(), inet::ExtInterface::initialize(), inet::PPP::initialize(), and inet::EtherMACBase::initialize().

{
    cSimpleModule::initialize(stage);

    if (stage == INITSTAGE_LOCAL) {
        hostModule = findContainingNode(this);
        if (hostModule)
            hostModule->subscribe(NF_INTERFACE_DELETED, this);
    }
    else if (stage == INITSTAGE_LINK_LAYER) {
        updateOperationalFlag(isNodeUp());    // needs to be done when interface is already registered (=last stage)
    }
}

bool inet::MACBase::isNodeUp ( )

protectedvirtual

Referenced by initialize(), and updateOperationalFlag().

{
    NodeStatus *nodeStatus = dynamic_cast<NodeStatus *>(hostModule->getSubmodule("status"));
    return !nodeStatus || nodeStatus->getState() == NodeStatus::UP;
}

virtual bool inet::MACBase::isUpperMsg ( cMessage *  msg )

protectedpure virtual

should return true if the msg arrived from upper layer, else return false

Implemented in inet::EtherMACBase, inet::PPP, inet::ExtInterface, inet::Loopback, and inet::TunInterface.

Referenced by handleMessageWhenDown().

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

inlineoverrideprotectedvirtual

Reimplemented in inet::EtherMACBase, inet::PPP, inet::ExtInterface, inet::Loopback, inet::TunInterface, inet::EtherMAC, and inet::EtherMACFullDuplex.

{ return NUM_INIT_STAGES; }

void inet::MACBase::receiveSignal ( cComponent *  source, simsignal_t  signalID, cObject *  obj, cObject *  details  )

overrideprotectedvirtual

Reimplemented in inet::EtherMACBase, and inet::PPP.

Referenced by inet::PPP::receiveSignal(), and inet::EtherMACBase::receiveSignal().

{
    if (signalID == NF_INTERFACE_DELETED) {
        if (interfaceEntry == check_and_cast<const InterfaceEntry *>(obj))
            interfaceEntry = nullptr;
    }
}

void inet::MACBase::registerInterface ( )

protected

Referenced by inet::TunInterface::initialize(), inet::Loopback::initialize(), inet::ExtInterface::initialize(), inet::PPP::initialize(), and inet::EtherMACBase::initialize().

{
    ASSERT(interfaceEntry == nullptr);
    IInterfaceTable *ift = findModuleFromPar<IInterfaceTable>(par("interfaceTableModule"), this);
    if (ift) {
        interfaceEntry = createInterfaceEntry();
        ift->addInterface(interfaceEntry);
    }
}

void inet::MACBase::updateOperationalFlag ( bool  isNodeUp )

protectedvirtual

Referenced by handleOperationStage(), and initialize().

{
    isOperational = isNodeUp;    // TODO and interface is up, too
}

Member Data Documentation

cModule* inet::MACBase::hostModule = nullptr

protected

Referenced by initialize(), and isNodeUp().

InterfaceEntry* inet::MACBase::interfaceEntry = nullptr

protected

Referenced by inet::EtherMACBase::createInterfaceEntry(), inet::PPP::initialize(), inet::EtherMACBase::readChannelParameters(), receiveSignal(), inet::PPP::refreshOutGateConnection(), and registerInterface().

bool inet::MACBase::isOperational = false

protected

Referenced by inet::EtherMACFullDuplex::handleMessage(), inet::EtherMAC::handleMessage(), inet::Loopback::handleMessage(), inet::ExtInterface::handleMessage(), inet::PPP::handleMessage(), and updateOperationalFlag().

---

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

• MACBase.h
• MACBase.cc