inet::MACProtocolBase Class Reference

#include <MACProtocolBase.h>

Inheritance diagram for inet::MACProtocolBase:

Public Attributes
InterfaceEntry *	interfaceEntry
int	upperLayerInGateId
	Gate ids. More...
int	upperLayerOutGateId
int	lowerLayerInGateId
int	lowerLayerOutGateId

Protected Member Functions
	MACProtocolBase ()
virtual void	initialize (int stage) override
virtual void	registerInterface ()
virtual InterfaceEntry *	createInterfaceEntry ()=0
virtual void	sendUp (cMessage *message)
virtual void	sendDown (cMessage *message)
virtual bool	isUpperMessage (cMessage *message) override
virtual bool	isLowerMessage (cMessage *message) override
virtual bool	isInitializeStage (int stage) override
virtual bool	isNodeStartStage (int stage) override
virtual bool	isNodeShutdownStage (int stage) override
Protected Member Functions inherited from inet::LayeredProtocolBase
virtual void	handleMessageWhenUp (cMessage *message) override
virtual void	handleSelfMessage (cMessage *message)
virtual void	handleUpperCommand (cMessage *message)
virtual void	handleLowerCommand (cMessage *message)
virtual void	handleUpperPacket (cPacket *packet)=0
virtual void	handleLowerPacket (cPacket *packet)=0
Protected Member Functions inherited from inet::OperationalBase
virtual int	numInitStages () const override
virtual void	handleMessage (cMessage *msg) override
virtual void	handleMessageWhenDown (cMessage *msg)
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 void	setOperational (bool isOperational)

Additional Inherited Members
Public Member Functions inherited from inet::OperationalBase
	OperationalBase ()
Public Member Functions inherited from inet::ILifecycle
virtual	~ILifecycle ()
Static Public Attributes inherited from inet::LayeredProtocolBase
static simsignal_t	packetSentToUpperSignal = registerSignal("packetSentToUpper")
static simsignal_t	packetReceivedFromUpperSignal = registerSignal("packetReceivedFromUpper")
static simsignal_t	packetFromUpperDroppedSignal = registerSignal("packetFromUpperDropped")
static simsignal_t	packetSentToLowerSignal = registerSignal("packetSentToLower")
static simsignal_t	packetReceivedFromLowerSignal = registerSignal("packetReceivedFromLower")
static simsignal_t	packetFromLowerDroppedSignal = registerSignal("packetFromLowerDropped")
Protected Attributes inherited from inet::OperationalBase
bool	isOperational
simtime_t	lastChange

Constructor & Destructor Documentation

inet::MACProtocolBase::MACProtocolBase ( )

protected

                                 :
    upperLayerInGateId(-1),
    upperLayerOutGateId(-1),
    lowerLayerInGateId(-1),
    lowerLayerOutGateId(-1),
    interfaceEntry(nullptr)
{
}

Member Function Documentation

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

protectedpure virtual

Implemented in inet::CSMA, inet::BMacLayer, inet::CsmaCaMac, inet::LMacLayer, inet::ieee80211::Ieee80211Mac, and inet::IdealMac.

Referenced by registerInterface().

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

overrideprotectedvirtual

Reimplemented from inet::OperationalBase.

Reimplemented in inet::CsmaCaMac, inet::LMacLayer, inet::CSMA, inet::IdealMac, inet::BMacLayer, and inet::ieee80211::Ieee80211Mac.

Referenced by inet::ieee80211::Ieee80211Mac::initialize(), inet::BMacLayer::initialize(), inet::IdealMac::initialize(), inet::CSMA::initialize(), inet::LMacLayer::initialize(), and inet::CsmaCaMac::initialize().

{
    LayeredProtocolBase::initialize(stage);
    if (stage == INITSTAGE_LOCAL) {
        upperLayerInGateId = findGate("upperLayerIn");
        upperLayerOutGateId = findGate("upperLayerOut");
        lowerLayerInGateId = findGate("lowerLayerIn");
        lowerLayerOutGateId = findGate("lowerLayerOut");
    }
}

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

inlineoverrideprotectedvirtual

Implements inet::OperationalBase.

{ return stage == INITSTAGE_LINK_LAYER; }

bool inet::MACProtocolBase::isLowerMessage ( cMessage *  message )

overrideprotectedvirtual

Implements inet::LayeredProtocolBase.

Referenced by inet::CsmaCaMac::handleWithFsm().

{
    return message->getArrivalGateId() == lowerLayerInGateId;
}

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

inlineoverrideprotectedvirtual

Implements inet::OperationalBase.

{ return stage == NodeShutdownOperation::STAGE_LINK_LAYER; }

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

inlineoverrideprotectedvirtual

Implements inet::OperationalBase.

{ return stage == NodeStartOperation::STAGE_LINK_LAYER; }

bool inet::MACProtocolBase::isUpperMessage ( cMessage *  message )

overrideprotectedvirtual

Implements inet::LayeredProtocolBase.

Referenced by inet::CsmaCaMac::handleWithFsm().

{
    return message->getArrivalGateId() == upperLayerInGateId;
}

void inet::MACProtocolBase::registerInterface ( )

protectedvirtual

Referenced by inet::ieee80211::Ieee80211Mac::initialize(), inet::BMacLayer::initialize(), inet::IdealMac::initialize(), inet::CSMA::initialize(), inet::LMacLayer::initialize(), and inet::CsmaCaMac::initialize().

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

void inet::MACProtocolBase::sendDown ( cMessage *  message )

protectedvirtual

Referenced by inet::ieee80211::Ieee80211Mac::configureRadioMode(), inet::LMacLayer::handleSelfMessage(), inet::ieee80211::Ieee80211Mac::handleUpperCommand(), inet::CsmaCaMac::sendAckFrame(), inet::CsmaCaMac::sendDataFrame(), inet::BMacLayer::sendDataPacket(), inet::ieee80211::Ieee80211Mac::sendDownPendingRadioConfigMsg(), inet::ieee80211::Ieee80211Mac::sendFrame(), inet::BMacLayer::sendMacAck(), inet::BMacLayer::sendPreamble(), inet::IdealMac::startTransmitting(), and inet::CSMA::updateStatusSIFS().

{
    if (message->isPacket())
        emit(packetSentToLowerSignal, message);
    send(message, lowerLayerOutGateId);
}

void inet::MACProtocolBase::sendUp ( cMessage *  message )

protectedvirtual

Reimplemented in inet::ieee80211::Ieee80211Mac.

Referenced by inet::IdealMac::handleLowerPacket(), inet::BMacLayer::handleSelfMessage(), inet::LMacLayer::handleSelfMessage(), inet::CsmaCaMac::handleWithFsm(), inet::ieee80211::Ieee80211Mac::sendUp(), inet::CSMA::updateStatusBackoff(), inet::CSMA::updateStatusCCA(), inet::CSMA::updateStatusIdle(), inet::CSMA::updateStatusSIFS(), and inet::CSMA::updateStatusWaitAck().

{
    if (message->isPacket())
        emit(packetSentToUpperSignal, message);
    send(message, upperLayerOutGateId);
}

Member Data Documentation

InterfaceEntry* inet::MACProtocolBase::interfaceEntry

Referenced by registerInterface(), inet::LMacLayer::setUpControlInfo(), and inet::BMacLayer::setUpControlInfo().

int inet::MACProtocolBase::lowerLayerInGateId

Referenced by initialize(), and isLowerMessage().

int inet::MACProtocolBase::lowerLayerOutGateId

Referenced by initialize(), sendDown(), and inet::CSMA::updateStatusCCA().

int inet::MACProtocolBase::upperLayerInGateId

Gate ids.

Referenced by initialize(), and isUpperMessage().

int inet::MACProtocolBase::upperLayerOutGateId

Referenced by initialize(), and sendUp().

---

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

• MACProtocolBase.h
• MACProtocolBase.cc