inet::EtherAppCli Class Reference

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

#include <EtherAppCli.h>

Inheritance diagram for inet::EtherAppCli:

Public Member Functions
	EtherAppCli ()
virtual	~EtherAppCli ()
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 (bool start)
virtual void	cancelNextPacket ()
virtual MACAddress	resolveDestMACAddress ()
virtual void	sendPacket ()
virtual void	receivePacket (cPacket *msg)
virtual void	registerDSAP (int dsap)
virtual bool	handleOperationStage (LifecycleOperation *operation, int stage, IDoneCallback *doneCallback) override
	Perform one stage of a lifecycle operation. More...

Protected Attributes
long	seqNum = 0
cPar *	reqLength = nullptr
cPar *	respLength = nullptr
cPar *	sendInterval = nullptr
int	localSAP = -1
int	remoteSAP = -1
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::EtherAppCli::Kinds

protected

Enumerator
START
NEXT

{ START = 100, NEXT };

Constructor & Destructor Documentation

inet::EtherAppCli::EtherAppCli ( )

inline

{}

inet::EtherAppCli::~EtherAppCli ( )

virtual

{
    cancelAndDelete(timerMsg);
}

Member Function Documentation

void inet::EtherAppCli::cancelNextPacket ( )

protectedvirtual

Referenced by handleOperationStage().

{
    if (timerMsg)
        cancelEvent(timerMsg);
}

void inet::EtherAppCli::finish ( )

overrideprotectedvirtual

{
    cancelAndDelete(timerMsg);
    timerMsg = nullptr;
}

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

overrideprotectedvirtual

{
    if (!isNodeUp())
        throw cRuntimeError("Application is not running");
    if (msg->isSelfMessage()) {
        if (msg->getKind() == START) {
            bool registerSAP = par("registerSAP");
            if (registerSAP)
                registerDSAP(localSAP);

            destMACAddress = resolveDestMACAddress();
            // if no dest address given, nothing to do
            if (destMACAddress.isUnspecified())
                return;
        }
        sendPacket();
        scheduleNextPacket(false);
    }
    else
        receivePacket(check_and_cast<cPacket *>(msg));
}

bool inet::EtherAppCli::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(true);
    }
    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::EtherAppCli::initialize ( int  stage )

overrideprotectedvirtual

{
    cSimpleModule::initialize(stage);

    if (stage == INITSTAGE_LOCAL) {
        reqLength = &par("reqLength");
        respLength = &par("respLength");
        sendInterval = &par("sendInterval");

        localSAP = par("localSAP");
        remoteSAP = par("remoteSAP");

        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(true);
    }
}

bool inet::EtherAppCli::isGenerator ( )

protectedvirtual

Referenced by handleOperationStage(), and initialize().

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

bool inet::EtherAppCli::isNodeUp ( )

protectedvirtual

Referenced by handleMessage(), and initialize().

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

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

inlineoverrideprotectedvirtual

{ return NUM_INIT_STAGES; }

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

protectedvirtual

Referenced by handleMessage().

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

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

void inet::EtherAppCli::registerDSAP ( int  dsap )

protectedvirtual

Referenced by handleMessage().

{
    EV_DEBUG << getFullPath() << " registering DSAP " << dsap << "\n";

    Ieee802Ctrl *etherctrl = new Ieee802Ctrl();
    etherctrl->setDsap(dsap);
    cMessage *msg = new cMessage("register_DSAP", IEEE802CTRL_REGISTER_DSAP);
    msg->setControlInfo(etherctrl);

    send(msg, "out");
}

MACAddress inet::EtherAppCli::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::EtherAppCli::scheduleNextPacket ( bool  start )

protectedvirtual

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

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

void inet::EtherAppCli::sendPacket ( )

protectedvirtual

Referenced by handleMessage().

{
    seqNum++;

    char msgname[30];
    sprintf(msgname, "req-%d-%ld", getId(), seqNum);
    EV_INFO << "Generating packet `" << msgname << "'\n";

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

    datapacket->setRequestId(seqNum);

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

    long respLen = respLength->longValue();
    datapacket->setResponseBytes(respLen);

    Ieee802Ctrl *etherctrl = new Ieee802Ctrl();
    etherctrl->setSsap(localSAP);
    etherctrl->setDsap(remoteSAP);
    etherctrl->setDest(destMACAddress);
    datapacket->setControlInfo(etherctrl);

    emit(sentPkSignal, datapacket);
    send(datapacket, "out");
    packetsSent++;
}

Member Data Documentation

MACAddress inet::EtherAppCli::destMACAddress

protected

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

int inet::EtherAppCli::localSAP = -1

protected

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

NodeStatus* inet::EtherAppCli::nodeStatus = nullptr

protected

Referenced by initialize(), and isNodeUp().

long inet::EtherAppCli::packetsReceived = 0

protected

Referenced by initialize(), and receivePacket().

long inet::EtherAppCli::packetsSent = 0

protected

Referenced by initialize(), and sendPacket().

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

staticprotected

Referenced by receivePacket().

int inet::EtherAppCli::remoteSAP = -1

protected

Referenced by initialize(), and sendPacket().

cPar* inet::EtherAppCli::reqLength = nullptr

protected

Referenced by initialize(), and sendPacket().

cPar* inet::EtherAppCli::respLength = nullptr

protected

Referenced by initialize(), and sendPacket().

cPar* inet::EtherAppCli::sendInterval = nullptr

protected

Referenced by initialize(), and scheduleNextPacket().

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

staticprotected

Referenced by sendPacket().

long inet::EtherAppCli::seqNum = 0

protected

Referenced by initialize(), and sendPacket().

simtime_t inet::EtherAppCli::startTime

protected

Referenced by initialize(), and scheduleNextPacket().

simtime_t inet::EtherAppCli::stopTime

protected

Referenced by initialize(), and scheduleNextPacket().

cMessage* inet::EtherAppCli::timerMsg = nullptr

protected

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

---

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

• EtherAppCli.h
• EtherAppCli.cc