inet::ShortcutMac Class Reference

#include <ShortcutMac.h>

Inheritance diagram for inet::ShortcutMac:

Public Member Functions
	~ShortcutMac ()
Public Member Functions inherited from inet::OperationalMixin< cSimpleModule >
virtual	~OperationalMixin ()
	}@ More...
Public Member Functions inherited from inet::ILifecycle
virtual	~ILifecycle ()

Protected Member Functions
virtual void	initialize (int stage) override
virtual void	configureNetworkInterface () override
virtual void	handleMessageWhenUp (cMessage *message) override
virtual void	handleUpperPacket (Packet *packet) override
virtual void	handleLowerPacket (Packet *packet) override
virtual ShortcutMac *	findPeer (MacAddress address)
virtual void	sendToPeer (Packet *packet, ShortcutMac *peer)
virtual void	receiveFromPeer (Packet *packet)
Protected Member Functions inherited from inet::MacProtocolBase
	MacProtocolBase ()
virtual	~MacProtocolBase ()
virtual void	registerInterface ()
virtual MacAddress	parseMacAddressParameter (const char *addrstr)
virtual void	deleteCurrentTxFrame ()
virtual void	dropCurrentTxFrame (PacketDropDetails &details)
virtual void	handleMessageWhenDown (cMessage *msg) override
virtual void	sendUp (cMessage *message)
virtual void	sendDown (cMessage *message)
virtual bool	isUpperMessage (cMessage *message) const override
virtual bool	isLowerMessage (cMessage *message) const override
virtual bool	isInitializeStage (int stage) const override
virtual bool	isModuleStartStage (int stage) const override
virtual bool	isModuleStopStage (int stage) const override
virtual void	flushQueue (PacketDropDetails &details)
	should clear queue and emit signal "packetDropped" with entire packets More...
virtual void	clearQueue ()
	should clear queue silently More...
virtual void	receiveSignal (cComponent *source, simsignal_t signalID, cObject *obj, cObject *details) override
virtual void	handleStartOperation (LifecycleOperation *operation) override
virtual void	handleStopOperation (LifecycleOperation *operation) override
virtual void	handleCrashOperation (LifecycleOperation *operation) override
queueing::IPacketQueue *	getQueue (cGate *gate) const
virtual bool	canDequeuePacket () const
virtual Packet *	dequeuePacket ()
Protected Member Functions inherited from inet::LayeredProtocolBase
virtual void	handleSelfMessage (cMessage *message)
virtual void	handleUpperMessage (cMessage *message)
virtual void	handleLowerMessage (cMessage *message)
virtual void	handleUpperCommand (cMessage *message)
virtual void	handleLowerCommand (cMessage *message)
Protected Member Functions inherited from inet::OperationalMixin< cSimpleModule >
virtual int	numInitStages () const override
virtual void	refreshDisplay () const override
virtual void	handleMessage (cMessage *msg) override
virtual bool	handleOperationStage (LifecycleOperation *operation, IDoneCallback *doneCallback) override
	Perform one stage of a lifecycle operation. More...
virtual State	getInitialOperationalState () const
	Returns initial operational state: OPERATING or NOT_OPERATING. More...
virtual void	handleActiveOperationTimeout (cMessage *message)
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 ()

Protected Attributes
double	bitrate = NaN
cPar *	propagationDelay = nullptr
cPar *	lengthOverhead = nullptr
cPar *	durationOverhead = nullptr
cPar *	packetLoss = nullptr
Protected Attributes inherited from inet::MacProtocolBase
int	upperLayerInGateId = -1
	Gate ids. More...
int	upperLayerOutGateId = -1
int	lowerLayerInGateId = -1
int	lowerLayerOutGateId = -1
opp_component_ptr< NetworkInterface >	networkInterface
opp_component_ptr< cModule >	hostModule
Packet *	currentTxFrame = nullptr
	Currently transmitted frame if any. More...
opp_component_ptr< queueing::IPacketQueue >	txQueue
	Messages received from upper layer and to be transmitted later. More...
Protected Attributes inherited from inet::OperationalMixin< cSimpleModule >
State	operationalState
simtime_t	lastChange
Operation	activeOperation
cMessage *	activeOperationTimeout
cMessage *	activeOperationExtraTimer

Static Protected Attributes
static std::map< MacAddress, ShortcutMac * >	shortcutMacs

Additional Inherited Members
Protected Types inherited from inet::OperationalMixin< cSimpleModule >
enum	State

Constructor & Destructor Documentation

~ShortcutMac()

inet::ShortcutMac::~ShortcutMac

(

)

{
    auto it = shortcutMacs.begin();
    while (it != shortcutMacs.end()) {
        if (it->second == this)
            it = shortcutMacs.erase(it);
        else
            ++it;
    }
}

Member Function Documentation

configureNetworkInterface()

void inet::ShortcutMac::configureNetworkInterface ( )

overrideprotectedvirtual

Implements inet::MacProtocolBase.

{
    MacAddress address = parseMacAddressParameter(par("address"));
    shortcutMacs[address] = this;
    networkInterface->setDatarate(bitrate);
    networkInterface->setMacAddress(address);
    networkInterface->setInterfaceToken(address.formInterfaceIdentifier());
    networkInterface->setMtu(par("mtu"));
    networkInterface->setMulticast(false);
    networkInterface->setBroadcast(true);
}

findPeer()

ShortcutMac * inet::ShortcutMac::findPeer ( MacAddress  address )

protectedvirtual

{
    auto it = shortcutMacs.find(address);
    return (it == shortcutMacs.end()) ? nullptr : it->second;
}

Referenced by handleUpperPacket().

handleLowerPacket()

void inet::ShortcutMac::handleLowerPacket ( Packet *  packet )

overrideprotectedvirtual

Reimplemented from inet::LayeredProtocolBase.

{
    throw cRuntimeError("Received lower packet is unexpected");
}

handleMessageWhenUp()

void inet::ShortcutMac::handleMessageWhenUp ( cMessage *  message )

overrideprotectedvirtual

Reimplemented from inet::LayeredProtocolBase.

{
    if (message->getArrivalGate() == gate("peerIn"))
        receiveFromPeer(check_and_cast<Packet *>(message));
    else
        MacProtocolBase::handleMessageWhenUp(message);
}

handleUpperPacket()

void inet::ShortcutMac::handleUpperPacket ( Packet *  packet )

overrideprotectedvirtual

Reimplemented from inet::LayeredProtocolBase.

{
    auto destination = packet->getTag<MacAddressReq>()->getDestAddress();
    if (destination.isBroadcast()) {
        for (auto it : shortcutMacs)
            if (it.second != this)
                sendToPeer(packet->dup(), it.second);
        delete packet;
    }
    else {
        auto peer = findPeer(destination);
        if (peer != nullptr)
            sendToPeer(packet, peer);
        else
            throw cRuntimeError("ShortcutMac not found");
    }
}

initialize()

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

overrideprotectedvirtual

Reimplemented from inet::MacProtocolBase.

{
    MacProtocolBase::initialize(stage);
    if (stage == INITSTAGE_LOCAL) {
        bitrate = par("bitrate");
        propagationDelay = &par("propagationDelay");
        lengthOverhead = &par("lengthOverhead");
        durationOverhead = &par("durationOverhead");
        packetLoss = &par("packetLoss");
    }
}

receiveFromPeer()

void inet::ShortcutMac::receiveFromPeer ( Packet *  packet )

protectedvirtual

{
    auto& packetProtocolTag = packet->getTagForUpdate<PacketProtocolTag>();
    auto packetProtocol = packetProtocolTag->getProtocol();
    if (packetProtocol == &Protocol::shortcutMac) {
        const auto& header = packet->popAtFront<ShortcutMacHeader>();
        packetProtocol = header->getPayloadProtocol();
        packetProtocolTag->setProtocol(packetProtocol);
    }
    packet->addTag<DispatchProtocolReq>()->setProtocol(packetProtocol);
    packet->addTag<InterfaceInd>()->setInterfaceId(networkInterface->getInterfaceId());
    sendUp(packet);
}

Referenced by handleMessageWhenUp().

sendToPeer()

void inet::ShortcutMac::sendToPeer ( Packet *  packet, ShortcutMac *  peer  )

protectedvirtual

{
    if (dblrand() < packetLoss->doubleValue()) {
        EV_WARN << "Packet " << packet << " lost.";
        delete packet;
    }
    else {
        auto length = b(lengthOverhead->intValue());
        auto packetProtocol = packet->getTag<PacketProtocolTag>()->getProtocol();
        packet->clearTags();
        if (length != b(0)) {
            auto header = makeShared<ShortcutMacHeader>();
            header->setChunkLength(length);
            header->setPayloadProtocol(packetProtocol);
            packet->insertAtFront(header);
            packet->addTag<PacketProtocolTag>()->setProtocol(&Protocol::shortcutMac);
        }
        else
            packet->addTag<PacketProtocolTag>()->setProtocol(packetProtocol);
        simtime_t transmissionDuration = packet->getBitLength() / bitrate + durationOverhead->doubleValue();
        packet->setDuration(transmissionDuration);
        sendDirect(packet, propagationDelay->doubleValue(), transmissionDuration, peer->gate("peerIn"));
    }
}

Referenced by handleUpperPacket().

Member Data Documentation

bitrate

double inet::ShortcutMac::bitrate = NaN

protected

Referenced by configureNetworkInterface(), initialize(), and sendToPeer().

durationOverhead

cPar* inet::ShortcutMac::durationOverhead = nullptr

protected

Referenced by initialize(), and sendToPeer().

lengthOverhead

cPar* inet::ShortcutMac::lengthOverhead = nullptr

protected

Referenced by initialize(), and sendToPeer().

packetLoss

cPar* inet::ShortcutMac::packetLoss = nullptr

protected

Referenced by initialize(), and sendToPeer().

propagationDelay

cPar* inet::ShortcutMac::propagationDelay = nullptr

protected

Referenced by initialize(), and sendToPeer().

shortcutMacs

std::map< MacAddress, ShortcutMac * > inet::ShortcutMac::shortcutMacs

staticprotected

Referenced by configureNetworkInterface(), findPeer(), handleUpperPacket(), and ~ShortcutMac().

---

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

• ShortcutMac.h
• ShortcutMac.cc