inet::IPvXTrafGen Class Reference

IP traffic generator application. More...

#include <IPvXTrafGen.h>

Inheritance diagram for inet::IPvXTrafGen:

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

Protected Types
enum	Kinds { START = 100, NEXT }

Protected Member Functions
virtual void	scheduleNextPacket (simtime_t previous)
virtual void	cancelNextPacket ()
virtual bool	isNodeUp ()
virtual bool	isEnabled ()
virtual L3Address	chooseDestAddr ()
virtual void	sendPacket ()
virtual int	numInitStages () const override
virtual void	initialize (int stage) override
virtual void	handleMessage (cMessage *msg) override
virtual void	refreshDisplay () const override
virtual void	startApp ()
virtual void	printPacket (cPacket *msg)
virtual void	processPacket (cPacket *msg)
virtual bool	handleOperationStage (LifecycleOperation *operation, int stage, IDoneCallback *doneCallback) override
	Perform one stage of a lifecycle operation. More...

Protected Attributes
simtime_t	startTime
simtime_t	stopTime
cPar *	sendIntervalPar = nullptr
cPar *	packetLengthPar = nullptr
int	protocol = -1
std::vector< L3Address >	destAddresses
int	numPackets = 0
NodeStatus *	nodeStatus = nullptr
cMessage *	timer = nullptr
bool	isOperational = false
int	numSent = 0
int	numReceived = 0

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

Detailed Description

IP traffic generator application.

See NED for more info.

Member Enumeration Documentation

enum inet::IPvXTrafGen::Kinds

protected

Enumerator
START
NEXT

{ START = 100, NEXT };

Constructor & Destructor Documentation

inet::IPvXTrafGen::IPvXTrafGen

(

)

{
}

inet::IPvXTrafGen::~IPvXTrafGen ( )

virtual

{
    cancelAndDelete(timer);
}

Member Function Documentation

void inet::IPvXTrafGen::cancelNextPacket ( )

protectedvirtual

Referenced by handleOperationStage().

{
    cancelEvent(timer);
}

L3Address inet::IPvXTrafGen::chooseDestAddr ( )

protectedvirtual

Referenced by sendPacket().

{
    int k = intrand(destAddresses.size());
    return destAddresses[k];
}

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

overrideprotectedvirtual

{
    if (!isNodeUp())
        throw cRuntimeError("Application is not running");
    if (msg == timer) {
        if (msg->getKind() == START) {
            destAddresses.clear();
            const char *destAddrs = par("destAddresses");
            cStringTokenizer tokenizer(destAddrs);
            const char *token;
            while ((token = tokenizer.nextToken()) != nullptr) {
                L3Address result;
                L3AddressResolver().tryResolve(token, result);
                if (result.isUnspecified())
                    EV_ERROR << "cannot resolve destination address: " << token << endl;
                else
                    destAddresses.push_back(result);
            }
        }
        if (!destAddresses.empty()) {
            sendPacket();
            if (isEnabled())
                scheduleNextPacket(simTime());
        }
    }
    else
        processPacket(PK(msg));
}

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

overrideprotectedvirtual

{
    cSimpleModule::initialize(stage);

    // because of IPvXAddressResolver, we need to wait until interfaces are registered,
    // address auto-assignment takes place etc.
    if (stage == INITSTAGE_LOCAL) {
        protocol = par("protocol");
        numPackets = par("numPackets");
        startTime = par("startTime");
        stopTime = par("stopTime");
        if (stopTime >= SIMTIME_ZERO && stopTime < startTime)
            throw cRuntimeError("Invalid startTime/stopTime parameters");

        packetLengthPar = &par("packetLength");
        sendIntervalPar = &par("sendInterval");

        numSent = 0;
        numReceived = 0;
        WATCH(numSent);
        WATCH(numReceived);
    }
    else if (stage == INITSTAGE_APPLICATION_LAYER) {
        IPSocket ipSocket(gate("ipOut"));
        ipSocket.registerProtocol(protocol);

        timer = new cMessage("sendTimer");
        nodeStatus = dynamic_cast<NodeStatus *>(findContainingNode(this)->getSubmodule("status"));
        isOperational = (!nodeStatus) || nodeStatus->getState() == NodeStatus::UP;

        if (isNodeUp())
            startApp();
    }
}

bool inet::IPvXTrafGen::isEnabled ( )

protectedvirtual

Referenced by handleMessage(), and startApp().

{
    return numPackets == -1 || numSent < numPackets;
}

bool inet::IPvXTrafGen::isNodeUp ( )

protectedvirtual

Referenced by handleMessage(), and initialize().

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

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

inlineoverrideprotectedvirtual

{ return NUM_INIT_STAGES; }

void inet::IPvXTrafGen::printPacket ( cPacket *  msg )

protectedvirtual

Referenced by processPacket(), and sendPacket().

{
    L3Address src, dest;
    int protocol = -1;

    INetworkProtocolControlInfo *ctrl = dynamic_cast<INetworkProtocolControlInfo *>(msg->getControlInfo());
    if (ctrl != nullptr) {
        src = ctrl->getSourceAddress();
        dest = ctrl->getDestinationAddress();
        protocol = ctrl->getTransportProtocol();
    }

    EV_INFO << msg << endl;
    EV_INFO << "Payload length: " << msg->getByteLength() << " bytes" << endl;

    if (protocol != -1)
        EV_INFO << "src: " << src << "  dest: " << dest << "  protocol=" << protocol << "\n";
}

void inet::IPvXTrafGen::processPacket ( cPacket *  msg )

protectedvirtual

Referenced by handleMessage().

{
    emit(rcvdPkSignal, msg);
    EV_INFO << "Received packet: ";
    printPacket(msg);
    delete msg;
    numReceived++;
}

void inet::IPvXTrafGen::refreshDisplay ( ) const

overrideprotectedvirtual

{
    char buf[40];
    sprintf(buf, "rcvd: %d pks\nsent: %d pks", numReceived, numSent);
    getDisplayString().setTagArg("t", 0, buf);
}

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

protectedvirtual

Referenced by handleMessage(), and startApp().

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

void inet::IPvXTrafGen::sendPacket ( )

protectedvirtual

Referenced by handleMessage().

{
    char msgName[32];
    sprintf(msgName, "appData-%d", numSent);

    cPacket *payload = new cPacket(msgName);
    payload->setByteLength(packetLengthPar->longValue());

    L3Address destAddr = chooseDestAddr();

    IL3AddressType *addressType = destAddr.getAddressType();
    INetworkProtocolControlInfo *controlInfo = addressType->createNetworkProtocolControlInfo();
    //controlInfo->setSourceAddress();
    controlInfo->setDestinationAddress(destAddr);
    controlInfo->setTransportProtocol(protocol);
    payload->setControlInfo(check_and_cast<cObject *>(controlInfo));

    EV_INFO << "Sending packet: ";
    printPacket(payload);
    emit(sentPkSignal, payload);
    send(payload, "ipOut");
    numSent++;
}

void inet::IPvXTrafGen::startApp ( )

protectedvirtual

Referenced by handleOperationStage(), and initialize().

{
    if (isEnabled())
        scheduleNextPacket(-1);
}

Member Data Documentation

std::vector<L3Address> inet::IPvXTrafGen::destAddresses

protected

Referenced by chooseDestAddr(), and handleMessage().

bool inet::IPvXTrafGen::isOperational = false

protected

Referenced by initialize().

NodeStatus* inet::IPvXTrafGen::nodeStatus = nullptr

protected

Referenced by initialize(), and isNodeUp().

int inet::IPvXTrafGen::numPackets = 0

protected

Referenced by initialize(), and isEnabled().

int inet::IPvXTrafGen::numReceived = 0

protected

Referenced by initialize(), processPacket(), and refreshDisplay().

int inet::IPvXTrafGen::numSent = 0

protected

Referenced by initialize(), isEnabled(), refreshDisplay(), and sendPacket().

cPar* inet::IPvXTrafGen::packetLengthPar = nullptr

protected

Referenced by initialize(), and sendPacket().

int inet::IPvXTrafGen::protocol = -1

protected

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

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

staticprotected

Referenced by processPacket().

cPar* inet::IPvXTrafGen::sendIntervalPar = nullptr

protected

Referenced by initialize(), and scheduleNextPacket().

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

staticprotected

Referenced by sendPacket().

simtime_t inet::IPvXTrafGen::startTime

protected

Referenced by initialize(), and scheduleNextPacket().

simtime_t inet::IPvXTrafGen::stopTime

protected

Referenced by initialize(), and scheduleNextPacket().

cMessage* inet::IPvXTrafGen::timer = nullptr

protected

Referenced by cancelNextPacket(), handleMessage(), initialize(), scheduleNextPacket(), and ~IPvXTrafGen().

---

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

• IPvXTrafGen.h
• IPvXTrafGen.cc