inet::MACRelayUnit Class Reference

#include <MACRelayUnit.h>

Inheritance diagram for inet::MACRelayUnit:

Public Member Functions
virtual bool	handleOperationStage (LifecycleOperation *operation, int stage, IDoneCallback *doneCallback) override
	Perform one stage of a lifecycle operation. More...
Public Member Functions inherited from inet::ILifecycle
virtual	~ILifecycle ()

Protected Member Functions
virtual void	initialize (int stage) override
virtual int	numInitStages () const override
virtual void	handleAndDispatchFrame (EtherFrame *frame)
	Updates address table with source address, determines output port and sends out (or broadcasts) frame on ports. More...
virtual void	broadcastFrame (EtherFrame *frame, int inputport)
	Utility function: sends the frame on all ports except inputport. More...
virtual void	handleMessage (cMessage *msg) override
	Calls handleIncomingFrame() for frames arrived from outside, and processFrame() for self messages. More...
virtual void	finish () override
	Writes statistics. More...
virtual void	start ()
virtual void	stop ()

Protected Attributes
IMACAddressTable *	addressTable = nullptr
int	numPorts = 0
long	numProcessedFrames = 0
long	numDiscardedFrames = 0
bool	isOperational = false

Member Function Documentation

void inet::MACRelayUnit::broadcastFrame ( EtherFrame *  frame, int  inputport  )

protectedvirtual

Utility function: sends the frame on all ports except inputport.

The message pointer should not be referenced any more after this call.

Referenced by handleAndDispatchFrame().

{
    for (int i = 0; i < numPorts; ++i) {
        if (i != inputport) {
            emit(LayeredProtocolBase::packetSentToLowerSignal, frame);
            send(frame->dup(), "ifOut", i);
        }
    }

    delete frame;
}

void inet::MACRelayUnit::finish ( )

overrideprotectedvirtual

Writes statistics.

{
    recordScalar("processed frames", numProcessedFrames);
    recordScalar("discarded frames", numDiscardedFrames);
}

void inet::MACRelayUnit::handleAndDispatchFrame ( EtherFrame *  frame )

protectedvirtual

Updates address table with source address, determines output port and sends out (or broadcasts) frame on ports.

Includes calls to updateTableWithAddress() and getPortForAddress().

The message pointer should not be referenced any more after this call.

Referenced by handleMessage().

{
    int inputport = frame->getArrivalGate()->getIndex();

    numProcessedFrames++;

    // update address table
    addressTable->updateTableWithAddress(inputport, frame->getSrc());

    // handle broadcast frames first
    if (frame->getDest().isBroadcast()) {
        EV << "Broadcasting broadcast frame " << frame << endl;
        broadcastFrame(frame, inputport);
        return;
    }

    // Finds output port of destination address and sends to output port
    // if not found then broadcasts to all other ports instead
    int outputport = addressTable->getPortForAddress(frame->getDest());
    // should not send out the same frame on the same ethernet port
    // (although wireless ports are ok to receive the same message)
    if (inputport == outputport) {
        EV << "Output port is same as input port, " << frame->getFullName()
           << " dest " << frame->getDest() << ", discarding frame\n";
        numDiscardedFrames++;
        delete frame;
        return;
    }

    if (outputport >= 0) {
        EV << "Sending frame " << frame << " with dest address " << frame->getDest() << " to port " << outputport << endl;
        emit(LayeredProtocolBase::packetSentToLowerSignal, frame);
        send(frame, "ifOut", outputport);
    }
    else {
        EV << "Dest address " << frame->getDest() << " unknown, broadcasting frame " << frame << endl;
        broadcastFrame(frame, inputport);
    }
}

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

overrideprotectedvirtual

Calls handleIncomingFrame() for frames arrived from outside, and processFrame() for self messages.

{
    if (!isOperational) {
        EV << "Message '" << msg << "' arrived when module status is down, dropped it\n";
        delete msg;
        return;
    }
    EtherFrame *frame = check_and_cast<EtherFrame *>(msg);
    // Frame received from MAC unit
    emit(LayeredProtocolBase::packetReceivedFromLowerSignal, frame);
    handleAndDispatchFrame(frame);
}

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

overridevirtual

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 ((NodeStartOperation::Stage)stage == NodeStartOperation::STAGE_LINK_LAYER) {
            start();
        }
    }
    else if (dynamic_cast<NodeShutdownOperation *>(operation)) {
        if ((NodeShutdownOperation::Stage)stage == NodeShutdownOperation::STAGE_LINK_LAYER) {
            stop();
        }
    }
    else if (dynamic_cast<NodeCrashOperation *>(operation)) {
        if ((NodeCrashOperation::Stage)stage == NodeCrashOperation::STAGE_CRASH) {
            stop();
        }
    }
    else {
        throw cRuntimeError("Unsupported operation '%s'", operation->getClassName());
    }

    return true;
}

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

overrideprotectedvirtual

{
    if (stage == INITSTAGE_LOCAL) {
        // number of ports
        numPorts = gate("ifOut", 0)->size();
        if (gate("ifIn", 0)->size() != numPorts)
            throw cRuntimeError("the sizes of the ifIn[] and ifOut[] gate vectors must be the same");

        numProcessedFrames = numDiscardedFrames = 0;

        addressTable = check_and_cast<IMACAddressTable *>(getModuleByPath(par("macTablePath")));

        WATCH(numProcessedFrames);
        WATCH(numDiscardedFrames);
    }
    else if (stage == INITSTAGE_LINK_LAYER) {
        NodeStatus *nodeStatus = dynamic_cast<NodeStatus *>(findContainingNode(this)->getSubmodule("status"));
        isOperational = (!nodeStatus) || nodeStatus->getState() == NodeStatus::UP;
    }
}

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

inlineoverrideprotectedvirtual

{ return NUM_INIT_STAGES; }

void inet::MACRelayUnit::start ( )

protectedvirtual

Referenced by handleOperationStage().

{
    addressTable->clearTable();
    isOperational = true;
}

void inet::MACRelayUnit::stop ( )

protectedvirtual

Referenced by handleOperationStage().

{
    addressTable->clearTable();
    isOperational = false;
}

Member Data Documentation

IMACAddressTable* inet::MACRelayUnit::addressTable = nullptr

protected

Referenced by handleAndDispatchFrame(), initialize(), start(), and stop().

bool inet::MACRelayUnit::isOperational = false

protected

Referenced by handleMessage(), initialize(), start(), and stop().

long inet::MACRelayUnit::numDiscardedFrames = 0

protected

Referenced by finish(), handleAndDispatchFrame(), and initialize().

int inet::MACRelayUnit::numPorts = 0

protected

Referenced by broadcastFrame(), and initialize().

long inet::MACRelayUnit::numProcessedFrames = 0

protected

Referenced by finish(), handleAndDispatchFrame(), and initialize().

---

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

• MACRelayUnit.h
• MACRelayUnit.cc