inet::EtherTrafGen Class Reference

Simple traffic generator for the Ethernet model. More...

#include <EtherTrafGen.h>

Inheritance diagram for inet::EtherTrafGen:

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

Protected Types
enum	Kinds { START = 100, NEXT }

Protected Member Functions
virtual void	initialize (int stage) override
virtual int	numInitStages () const override
virtual void	handleMessage (cMessage *msg) override
virtual void	finish () override
virtual bool	isNodeUp ()
virtual bool	isGenerator ()
virtual void	scheduleNextPacket (simtime_t previous)
virtual void	cancelNextPacket ()
virtual MACAddress	resolveDestMACAddress ()
virtual void	sendBurstPackets ()
virtual void	receivePacket (cPacket *msg)
virtual bool	handleOperationStage (LifecycleOperation *operation, int stage, IDoneCallback *doneCallback) override
	Perform one stage of a lifecycle operation. More...

Protected Attributes
long	seqNum = 0
cPar *	sendInterval = nullptr
cPar *	numPacketsPerBurst = nullptr
cPar *	packetLength = nullptr
int	etherType = 0
MACAddress	destMACAddress
NodeStatus *	nodeStatus = nullptr
cMessage *	timerMsg = nullptr
simtime_t	startTime
simtime_t	stopTime
long	packetsSent = 0
long	packetsReceived = 0

Static Protected Attributes
static simsignal_t	sentPkSignal = registerSignal("sentPk")
static simsignal_t	rcvdPkSignal = registerSignal("rcvdPk")

Detailed Description

Simple traffic generator for the Ethernet model.

Member Enumeration Documentation

enum inet::EtherTrafGen::Kinds

protected

Enumerator
START
NEXT

{ START = 100, NEXT };

Constructor & Destructor Documentation

inet::EtherTrafGen::EtherTrafGen

(

)

{
    sendInterval = nullptr;
    numPacketsPerBurst = nullptr;
    packetLength = nullptr;
    timerMsg = nullptr;
    nodeStatus = nullptr;
}

inet::EtherTrafGen::~EtherTrafGen ( )

virtual

{
    cancelAndDelete(timerMsg);
}

Member Function Documentation

void inet::EtherTrafGen::cancelNextPacket ( )

protectedvirtual

Referenced by handleOperationStage().

{
    cancelEvent(timerMsg);
}

void inet::EtherTrafGen::finish ( )

overrideprotectedvirtual

{
    cancelAndDelete(timerMsg);
    timerMsg = nullptr;
}

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

overrideprotectedvirtual

{
    if (!isNodeUp())
        throw cRuntimeError("Application is not running");
    if (msg->isSelfMessage()) {
        if (msg->getKind() == START) {
            destMACAddress = resolveDestMACAddress();
            // if no dest address given, nothing to do
            if (destMACAddress.isUnspecified())
                return;
        }
        sendBurstPackets();
        scheduleNextPacket(simTime());
    }
    else
        receivePacket(check_and_cast<cPacket *>(msg));
}

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

{
    Enter_Method_Silent();
    if (dynamic_cast<NodeStartOperation *>(operation)) {
        if ((NodeStartOperation::Stage)stage == NodeStartOperation::STAGE_APPLICATION_LAYER && isGenerator())
            scheduleNextPacket(-1);
    }
    else if (dynamic_cast<NodeShutdownOperation *>(operation)) {
        if ((NodeShutdownOperation::Stage)stage == NodeShutdownOperation::STAGE_APPLICATION_LAYER)
            cancelNextPacket();
    }
    else if (dynamic_cast<NodeCrashOperation *>(operation)) {
        if ((NodeCrashOperation::Stage)stage == NodeCrashOperation::STAGE_CRASH)
            cancelNextPacket();
    }
    else
        throw cRuntimeError("Unsupported lifecycle operation '%s'", operation->getClassName());
    return true;
}

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

overrideprotectedvirtual

{
    cSimpleModule::initialize(stage);

    if (stage == INITSTAGE_LOCAL) {
        sendInterval = &par("sendInterval");
        numPacketsPerBurst = &par("numPacketsPerBurst");
        packetLength = &par("packetLength");
        etherType = par("etherType");

        seqNum = 0;
        WATCH(seqNum);

        // statistics
        packetsSent = packetsReceived = 0;
        WATCH(packetsSent);
        WATCH(packetsReceived);

        startTime = par("startTime");
        stopTime = par("stopTime");
        if (stopTime >= SIMTIME_ZERO && stopTime < startTime)
            throw cRuntimeError("Invalid startTime/stopTime parameters");
    }
    else if (stage == INITSTAGE_APPLICATION_LAYER) {
        if (isGenerator())
            timerMsg = new cMessage("generateNextPacket");

        nodeStatus = dynamic_cast<NodeStatus *>(findContainingNode(this)->getSubmodule("status"));
        if (isNodeUp() && isGenerator())
            scheduleNextPacket(-1);
    }
}

bool inet::EtherTrafGen::isGenerator ( )

protectedvirtual

Referenced by handleOperationStage(), and initialize().

{
    return par("destAddress").stringValue()[0];
}

bool inet::EtherTrafGen::isNodeUp ( )

protectedvirtual

Referenced by handleMessage(), and initialize().

{
    return !nodeStatus || nodeStatus->getState() == NodeStatus::UP;
}

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

inlineoverrideprotectedvirtual

{ return NUM_INIT_STAGES; }

void inet::EtherTrafGen::receivePacket ( cPacket *  msg )

protectedvirtual

Referenced by handleMessage().

{
    EV_INFO << "Received packet `" << msg->getName() << "' length= " << msg->getByteLength() << "B\n";

    packetsReceived++;
    emit(rcvdPkSignal, msg);
    delete msg;
}

MACAddress inet::EtherTrafGen::resolveDestMACAddress ( )

protectedvirtual

Referenced by handleMessage().

{
    MACAddress destMACAddress;
    const char *destAddress = par("destAddress");
    if (destAddress[0]) {
        // try as mac address first, then as a module
        if (!destMACAddress.tryParse(destAddress)) {
            cModule *destStation = getModuleByPath(destAddress);
            if (!destStation)
                throw cRuntimeError("cannot resolve MAC address '%s': not a 12-hex-digit MAC address or a valid module path name", destAddress);

            cModule *destMAC = destStation->getSubmodule("mac");
            if (!destMAC)
                throw cRuntimeError("module '%s' has no 'mac' submodule", destAddress);

            destMACAddress.setAddress(destMAC->par("address"));
        }
    }
    return destMACAddress;
}

void inet::EtherTrafGen::scheduleNextPacket ( simtime_t  previous )

protectedvirtual

Referenced by handleMessage(), handleOperationStage(), and initialize().

{
    simtime_t next;
    if (previous == -1) {
        next = simTime() <= startTime ? startTime : simTime();
        timerMsg->setKind(START);
    }
    else {
        next = previous + sendInterval->doubleValue();
        timerMsg->setKind(NEXT);
    }
    if (stopTime < SIMTIME_ZERO || next < stopTime)
        scheduleAt(next, timerMsg);
}

void inet::EtherTrafGen::sendBurstPackets ( )

protectedvirtual

Referenced by handleMessage().

{
    int n = numPacketsPerBurst->longValue();
    for (int i = 0; i < n; i++) {
        seqNum++;

        char msgname[40];
        sprintf(msgname, "pk-%d-%ld", getId(), seqNum);

        cPacket *datapacket = new cPacket(msgname, IEEE802CTRL_DATA);

        long len = packetLength->longValue();
        datapacket->setByteLength(len);

        Ieee802Ctrl *etherctrl = new Ieee802Ctrl();
        etherctrl->setEtherType(etherType);
        etherctrl->setDest(destMACAddress);
        datapacket->setControlInfo(etherctrl);

        EV_INFO << "Send packet `" << msgname << "' dest=" << destMACAddress << " length=" << len << "B type=" << etherType << "\n";
        emit(sentPkSignal, datapacket);
        send(datapacket, "out");
        packetsSent++;
    }
}

Member Data Documentation

MACAddress inet::EtherTrafGen::destMACAddress

protected

Referenced by handleMessage(), resolveDestMACAddress(), and sendBurstPackets().

int inet::EtherTrafGen::etherType = 0

protected

Referenced by initialize(), and sendBurstPackets().

NodeStatus* inet::EtherTrafGen::nodeStatus = nullptr

protected

Referenced by EtherTrafGen(), initialize(), and isNodeUp().

cPar* inet::EtherTrafGen::numPacketsPerBurst = nullptr

protected

Referenced by EtherTrafGen(), initialize(), and sendBurstPackets().

cPar* inet::EtherTrafGen::packetLength = nullptr

protected

Referenced by EtherTrafGen(), initialize(), and sendBurstPackets().

long inet::EtherTrafGen::packetsReceived = 0

protected

Referenced by initialize(), and receivePacket().

long inet::EtherTrafGen::packetsSent = 0

protected

Referenced by initialize(), and sendBurstPackets().

simsignal_t inet::EtherTrafGen::rcvdPkSignal = registerSignal("rcvdPk")

staticprotected

Referenced by receivePacket().

cPar* inet::EtherTrafGen::sendInterval = nullptr

protected

Referenced by EtherTrafGen(), initialize(), and scheduleNextPacket().

simsignal_t inet::EtherTrafGen::sentPkSignal = registerSignal("sentPk")

staticprotected

Referenced by sendBurstPackets().

long inet::EtherTrafGen::seqNum = 0

protected

Referenced by initialize(), and sendBurstPackets().

simtime_t inet::EtherTrafGen::startTime

protected

Referenced by initialize(), and scheduleNextPacket().

simtime_t inet::EtherTrafGen::stopTime

protected

Referenced by initialize(), and scheduleNextPacket().

cMessage* inet::EtherTrafGen::timerMsg = nullptr

protected

Referenced by cancelNextPacket(), EtherTrafGen(), finish(), initialize(), scheduleNextPacket(), and ~EtherTrafGen().

---

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

• EtherTrafGen.h
• EtherTrafGen.cc