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::ApplicationBase
	ApplicationBase ()
Public Member Functions inherited from inet::OperationalMixin< cSimpleModule >
virtual	~OperationalMixin ()
	}@ More...
Public Member Functions inherited from inet::ILifecycle
virtual	~ILifecycle ()

Protected Types
enum	Kinds { START = 100, NEXT }
Protected Types inherited from inet::OperationalMixin< cSimpleModule >
enum	State

Protected Member Functions
virtual void	scheduleNextPacket (simtime_t previous)
virtual void	cancelNextPacket ()
virtual bool	isEnabled ()
virtual L3Address	chooseDestAddr ()
virtual void	sendPacket ()
virtual int	numInitStages () const override
virtual void	initialize (int stage) override
virtual void	handleMessageWhenUp (cMessage *msg) override
virtual void	refreshDisplay () const override
virtual void	startApp ()
virtual void	printPacket (Packet *msg)
virtual void	processPacket (Packet *msg)
virtual void	handleStartOperation (LifecycleOperation *operation) override
virtual void	handleStopOperation (LifecycleOperation *operation) override
virtual void	handleCrashOperation (LifecycleOperation *operation) override
Protected Member Functions inherited from inet::ApplicationBase
virtual bool	isInitializeStage (int stage) const override
virtual bool	isModuleStartStage (int stage) const override
virtual bool	isModuleStopStage (int stage) const override
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 void	handleMessageWhenDown (cMessage *msg)
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
simtime_t	startTime
simtime_t	stopTime
cPar *	sendIntervalPar = nullptr
cPar *	packetLengthPar = nullptr
const Protocol *	protocol = nullptr
std::vector< L3Address >	destAddresses
int	numPackets = 0
cMessage *	timer = nullptr
int	numSent = 0
int	numReceived = 0
Protected Attributes inherited from inet::OperationalMixin< cSimpleModule >
State	operationalState
simtime_t	lastChange
Operation	activeOperation
cMessage *	activeOperationTimeout
cMessage *	activeOperationExtraTimer

Static Protected Attributes
static std::vector< const Protocol * >	allocatedProtocols

Friends
void	ipvxTrafGenClearProtocols ()

Detailed Description

IP traffic generator application.

See NED for more info.

Member Enumeration Documentation

Kinds

enum inet::IpvxTrafGen::Kinds

protected

Enumerator
START
NEXT

{ START = 100, NEXT };

Constructor & Destructor Documentation

IpvxTrafGen()

inet::IpvxTrafGen::IpvxTrafGen

(

)

{
}

~IpvxTrafGen()

inet::IpvxTrafGen::~IpvxTrafGen ( )

virtual

{
    cancelAndDelete(timer);
}

Member Function Documentation

cancelNextPacket()

void inet::IpvxTrafGen::cancelNextPacket ( )

protectedvirtual

{
    cancelEvent(timer);
}

Referenced by handleCrashOperation(), and handleStopOperation().

chooseDestAddr()

L3Address inet::IpvxTrafGen::chooseDestAddr ( )

protectedvirtual

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

Referenced by sendPacket().

handleCrashOperation()

void inet::IpvxTrafGen::handleCrashOperation ( LifecycleOperation *  operation )

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    cancelNextPacket();
}

handleMessageWhenUp()

void inet::IpvxTrafGen::handleMessageWhenUp ( cMessage *  msg )

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    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(check_and_cast<Packet *>(msg));
}

handleStartOperation()

void inet::IpvxTrafGen::handleStartOperation ( LifecycleOperation *  operation )

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    startApp();
}

handleStopOperation()

void inet::IpvxTrafGen::handleStopOperation ( LifecycleOperation *  operation )

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    cancelNextPacket();
}

initialize()

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

overrideprotectedvirtual

Reimplemented from inet::OperationalMixin< cSimpleModule >.

{
    ApplicationBase::initialize(stage);
 
    if (stage == INITSTAGE_LOCAL) {
        int protocolId = par("protocol");
        if (protocolId < 143 || protocolId > 254)
            throw cRuntimeError("invalid protocol id %d, accepts only between 143 and 254", protocolId);
        protocol = ProtocolGroup::ipprotocol.findProtocol(protocolId);
        if (!protocol) {
            std::string name = "prot_" + std::to_string(protocolId);
            protocol = new Protocol(name.c_str(), name.c_str());
            allocatedProtocols.push_back(protocol);
            ProtocolGroup::ipprotocol.addProtocol(protocolId, 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");
 
        timer = new cMessage("sendTimer");
 
        numSent = 0;
        numReceived = 0;
        WATCH(numSent);
        WATCH(numReceived);
    }
    else if (stage == INITSTAGE_APPLICATION_LAYER) {
        registerProtocol(*protocol, gate("ipOut"), gate("ipIn"));
    }
}

isEnabled()

bool inet::IpvxTrafGen::isEnabled ( )

protectedvirtual

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

Referenced by handleMessageWhenUp(), and startApp().

numInitStages()

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

inlineoverrideprotectedvirtual

{ return NUM_INIT_STAGES; }

printPacket()

void inet::IpvxTrafGen::printPacket ( Packet *  msg )

protectedvirtual

{
    L3Address src, dest;
    int protocol = -1;
    auto *ctrl = msg->getControlInfo();
    if (ctrl != nullptr) {
        protocol = ProtocolGroup::ipprotocol.getProtocolNumber(msg->getTag<PacketProtocolTag>()->getProtocol());
    }
    Ptr<const L3AddressTagBase> addresses = msg->findTag<L3AddressReq>();
    if (addresses == nullptr)
        addresses = msg->findTag<L3AddressInd>();
    if (addresses != nullptr) {
        src = addresses->getSrcAddress();
        dest = addresses->getDestAddress();
    }
 
    EV_INFO << msg << endl;
    EV_INFO << "Payload length: " << msg->getByteLength() << " bytes" << endl;
 
    if (protocol != -1)
        EV_INFO << "src: " << src << "  dest: " << dest << "  protocol=" << protocol << "\n";
}

Referenced by processPacket(), and sendPacket().

processPacket()

void inet::IpvxTrafGen::processPacket ( Packet *  msg )

protectedvirtual

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

Referenced by handleMessageWhenUp().

refreshDisplay()

void inet::IpvxTrafGen::refreshDisplay ( ) const

overrideprotectedvirtual

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

scheduleNextPacket()

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

protectedvirtual

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

Referenced by handleMessageWhenUp(), and startApp().

sendPacket()

void inet::IpvxTrafGen::sendPacket ( )

protectedvirtual

{
    char msgName[32];
    sprintf(msgName, "appData-%d", numSent);
 
    Packet *packet = new Packet(msgName);
    const auto& payload = makeShared<ByteCountChunk>(B(*packetLengthPar));
    payload->addTag<CreationTimeTag>()->setCreationTime(simTime());
    packet->insertAtBack(payload);
 
    L3Address destAddr = chooseDestAddr();
 
    IL3AddressType *addressType = destAddr.getAddressType();
    packet->addTag<PacketProtocolTag>()->setProtocol(protocol);
    packet->addTag<DispatchProtocolReq>()->setProtocol(addressType->getNetworkProtocol());
    packet->addTag<L3AddressReq>()->setDestAddress(destAddr);
 
    EV_INFO << "Sending packet: ";
    printPacket(packet);
    emit(packetSentSignal, packet);
    send(packet, "ipOut");
    numSent++;
}

Referenced by handleMessageWhenUp().

startApp()

void inet::IpvxTrafGen::startApp ( )

protectedvirtual

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

Referenced by handleStartOperation().

Friends And Related Function Documentation

ipvxTrafGenClearProtocols

void ipvxTrafGenClearProtocols ( )

friend

{
    for (auto *p : IpvxTrafGen::allocatedProtocols)
        delete p;
    IpvxTrafGen::allocatedProtocols.clear();
}

Member Data Documentation

allocatedProtocols

std::vector< const Protocol * > inet::IpvxTrafGen::allocatedProtocols

staticprotected

Referenced by initialize(), and inet::ipvxTrafGenClearProtocols().

destAddresses

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

protected

Referenced by chooseDestAddr(), and handleMessageWhenUp().

numPackets

int inet::IpvxTrafGen::numPackets = 0

protected

Referenced by initialize(), and isEnabled().

numReceived

int inet::IpvxTrafGen::numReceived = 0

protected

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

numSent

int inet::IpvxTrafGen::numSent = 0

protected

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

packetLengthPar

cPar* inet::IpvxTrafGen::packetLengthPar = nullptr

protected

Referenced by initialize(), and sendPacket().

protocol

const Protocol* inet::IpvxTrafGen::protocol = nullptr

protected

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

sendIntervalPar

cPar* inet::IpvxTrafGen::sendIntervalPar = nullptr

protected

Referenced by initialize(), and scheduleNextPacket().

startTime

simtime_t inet::IpvxTrafGen::startTime

protected

Referenced by initialize(), and scheduleNextPacket().

stopTime

simtime_t inet::IpvxTrafGen::stopTime

protected

Referenced by initialize(), and scheduleNextPacket().

timer

cMessage* inet::IpvxTrafGen::timer = nullptr

protected

Referenced by cancelNextPacket(), handleMessageWhenUp(), initialize(), scheduleNextPacket(), and ~IpvxTrafGen().

---

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

• IpvxTrafGen.h
• IpvxTrafGen.cc