inet::UDPBasicBurst Class Reference

UDP application. More...

#include <UDPBasicBurst.h>

Inheritance diagram for inet::UDPBasicBurst:

Public Types
enum	ChooseDestAddrMode { ONCE = 1, PER_BURST, PER_SEND }

Public Member Functions
	UDPBasicBurst ()
	~UDPBasicBurst ()
Public Member Functions inherited from inet::ApplicationBase
	ApplicationBase ()
Public Member Functions inherited from inet::OperationalBase
	OperationalBase ()
Public Member Functions inherited from inet::ILifecycle
virtual	~ILifecycle ()

Protected Types
enum	SelfMsgKinds { START = 1, SEND, STOP }
typedef std::map< int, int >	SourceSequence

Protected Member Functions
virtual L3Address	chooseDestAddr ()
virtual cPacket *	createPacket ()
virtual void	processPacket (cPacket *msg)
virtual void	generateBurst ()
virtual int	numInitStages () const override
virtual void	initialize (int stage) override
virtual void	handleMessageWhenUp (cMessage *msg) override
virtual void	finish () override
virtual void	refreshDisplay () const override
virtual void	processStart ()
virtual void	processSend ()
virtual void	processStop ()
virtual bool	handleNodeStart (IDoneCallback *doneCallback) override
virtual bool	handleNodeShutdown (IDoneCallback *doneCallback) override
virtual void	handleNodeCrash () override
Protected Member Functions inherited from inet::ApplicationBase
virtual bool	isInitializeStage (int stage) override
virtual bool	isNodeStartStage (int stage) override
virtual bool	isNodeShutdownStage (int stage) override
Protected Member Functions inherited from inet::OperationalBase
virtual void	handleMessage (cMessage *msg) override
virtual void	handleMessageWhenDown (cMessage *msg)
virtual bool	handleOperationStage (LifecycleOperation *operation, int stage, IDoneCallback *doneCallback) override
	Perform one stage of a lifecycle operation. More...
virtual void	setOperational (bool isOperational)

Protected Attributes
std::vector< L3Address >	destAddresses
ChooseDestAddrMode	chooseDestAddrMode = (ChooseDestAddrMode)0
simtime_t	delayLimit
simtime_t	startTime
simtime_t	stopTime
int	localPort = -1
int	destPort = -1
int	destAddrRNG = -1
cPar *	messageLengthPar = nullptr
cPar *	burstDurationPar = nullptr
cPar *	sleepDurationPar = nullptr
cPar *	sendIntervalPar = nullptr
UDPSocket	socket
L3Address	destAddr
SourceSequence	sourceSequence
cMessage *	timerNext = nullptr
simtime_t	nextPkt
simtime_t	nextBurst
simtime_t	nextSleep
bool	isSource = false
bool	activeBurst = false
bool	haveSleepDuration = false
int	numSent = 0
int	numReceived = 0
int	numDeleted = 0
int	numDuplicated = 0
Protected Attributes inherited from inet::OperationalBase
bool	isOperational
simtime_t	lastChange

Static Protected Attributes
static int	counter
static simsignal_t	sentPkSignal = registerSignal("sentPk")
static simsignal_t	rcvdPkSignal = registerSignal("rcvdPk")
static simsignal_t	outOfOrderPkSignal = registerSignal("outOfOrderPk")
static simsignal_t	dropPkSignal = registerSignal("dropPk")

Detailed Description

UDP application.

See NED for more info.

Member Typedef Documentation

typedef std::map<int, int> inet::UDPBasicBurst::SourceSequence

protected

Member Enumeration Documentation

enum inet::UDPBasicBurst::ChooseDestAddrMode

Enumerator
ONCE
PER_BURST
PER_SEND

                            {
        ONCE = 1, PER_BURST, PER_SEND
    };

enum inet::UDPBasicBurst::SelfMsgKinds

protected

Enumerator
START
SEND
STOP

{ START = 1, SEND, STOP };

Constructor & Destructor Documentation

inet::UDPBasicBurst::UDPBasicBurst ( )

inline

{}

inet::UDPBasicBurst::~UDPBasicBurst

(

)

{
    cancelAndDelete(timerNext);
}

Member Function Documentation

L3Address inet::UDPBasicBurst::chooseDestAddr ( )

protectedvirtual

Referenced by generateBurst(), and processStart().

{
    if (destAddresses.size() == 1)
        return destAddresses[0];

    int k = getRNG(destAddrRNG)->intRand(destAddresses.size());
    return destAddresses[k];
}

cPacket * inet::UDPBasicBurst::createPacket ( )

protectedvirtual

Referenced by generateBurst().

{
    char msgName[32];
    sprintf(msgName, "UDPBasicAppData-%d", counter++);
    long msgByteLength = messageLengthPar->longValue();
    ApplicationPacket *payload = new ApplicationPacket(msgName);
    payload->setByteLength(msgByteLength);
    payload->setSequenceNumber(numSent);
    payload->addPar("sourceId") = getId();
    payload->addPar("msgId") = numSent;

    return payload;
}

void inet::UDPBasicBurst::finish ( )

overrideprotectedvirtual

{
    recordScalar("Total sent", numSent);
    recordScalar("Total received", numReceived);
    recordScalar("Total deleted", numDeleted);
    ApplicationBase::finish();
}

void inet::UDPBasicBurst::generateBurst ( )

protectedvirtual

Referenced by processSend().

{
    simtime_t now = simTime();

    if (nextPkt < now)
        nextPkt = now;

    double sendInterval = sendIntervalPar->doubleValue();
    if (sendInterval <= 0.0)
        throw cRuntimeError("The sendInterval parameter must be bigger than 0");
    nextPkt += sendInterval;

    if (activeBurst && nextBurst <= now) {    // new burst
        double burstDuration = burstDurationPar->doubleValue();
        if (burstDuration < 0.0)
            throw cRuntimeError("The burstDuration parameter mustn't be smaller than 0");
        double sleepDuration = sleepDurationPar->doubleValue();

        if (burstDuration == 0.0)
            activeBurst = false;
        else {
            if (sleepDuration < 0.0)
                throw cRuntimeError("The sleepDuration parameter mustn't be smaller than 0");
            nextSleep = now + burstDuration;
            nextBurst = nextSleep + sleepDuration;
        }

        if (chooseDestAddrMode == PER_BURST)
            destAddr = chooseDestAddr();
    }

    if (chooseDestAddrMode == PER_SEND)
        destAddr = chooseDestAddr();

    cPacket *payload = createPacket();
    payload->setTimestamp();
    emit(sentPkSignal, payload);
    socket.sendTo(payload, destAddr, destPort);
    numSent++;

    // Next timer
    if (activeBurst && nextPkt >= nextSleep)
        nextPkt = nextBurst;

    if (stopTime >= SIMTIME_ZERO && nextPkt >= stopTime) {
        timerNext->setKind(STOP);
        nextPkt = stopTime;
    }
    scheduleAt(nextPkt, timerNext);
}

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

overrideprotectedvirtual

Implements inet::OperationalBase.

{
    if (msg->isSelfMessage()) {
        switch (msg->getKind()) {
            case START:
                processStart();
                break;

            case SEND:
                processSend();
                break;

            case STOP:
                processStop();
                break;

            default:
                throw cRuntimeError("Invalid kind %d in self message", (int)msg->getKind());
        }
    }
    else if (msg->getKind() == UDP_I_DATA) {
        // process incoming packet
        processPacket(PK(msg));
    }
    else if (msg->getKind() == UDP_I_ERROR) {
        EV_WARN << "Ignoring UDP error report\n";
        delete msg;
    }
    else {
        throw cRuntimeError("Unrecognized message (%s)%s", msg->getClassName(), msg->getName());
    }
}

void inet::UDPBasicBurst::handleNodeCrash ( )

overrideprotectedvirtual

Reimplemented from inet::OperationalBase.

{
    if (timerNext)
        cancelEvent(timerNext);
    activeBurst = false;
}

bool inet::UDPBasicBurst::handleNodeShutdown ( IDoneCallback *  doneCallback )

overrideprotectedvirtual

Reimplemented from inet::OperationalBase.

{
    if (timerNext)
        cancelEvent(timerNext);
    activeBurst = false;
    //TODO if(socket.isOpened()) socket.close();
    return true;
}

bool inet::UDPBasicBurst::handleNodeStart ( IDoneCallback *  doneCallback )

overrideprotectedvirtual

Reimplemented from inet::OperationalBase.

{
    simtime_t start = std::max(startTime, simTime());

    if ((stopTime < SIMTIME_ZERO) || (start < stopTime) || (start == stopTime && startTime == stopTime)) {
        timerNext->setKind(START);
        scheduleAt(start, timerNext);
    }

    return true;
}

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

overrideprotectedvirtual

Reimplemented from inet::OperationalBase.

{
    ApplicationBase::initialize(stage);

    if (stage == INITSTAGE_LOCAL) {
        counter = 0;
        numSent = 0;
        numReceived = 0;
        numDeleted = 0;
        numDuplicated = 0;

        delayLimit = par("delayLimit");
        startTime = par("startTime");
        stopTime = par("stopTime");
        if (stopTime >= SIMTIME_ZERO && stopTime <= startTime)
            throw cRuntimeError("Invalid startTime/stopTime parameters");

        messageLengthPar = &par("messageLength");
        burstDurationPar = &par("burstDuration");
        sleepDurationPar = &par("sleepDuration");
        sendIntervalPar = &par("sendInterval");
        nextSleep = startTime;
        nextBurst = startTime;
        nextPkt = startTime;

        destAddrRNG = par("destAddrRNG");
        const char *addrModeStr = par("chooseDestAddrMode").stringValue();
        int addrMode = cEnum::get("inet::ChooseDestAddrMode")->lookup(addrModeStr);
        if (addrMode == -1)
            throw cRuntimeError("Invalid chooseDestAddrMode: '%s'", addrModeStr);
        chooseDestAddrMode = (ChooseDestAddrMode)addrMode;

        WATCH(numSent);
        WATCH(numReceived);
        WATCH(numDeleted);
        WATCH(numDuplicated);

        localPort = par("localPort");
        destPort = par("destPort");

        timerNext = new cMessage("UDPBasicBurstTimer");
    }
}

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

inlineoverrideprotectedvirtual

Reimplemented from inet::OperationalBase.

{ return NUM_INIT_STAGES; }

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

protectedvirtual

Referenced by handleMessageWhenUp().

{
    if (pk->getKind() == UDP_I_ERROR) {
        EV_WARN << "UDP error received\n";
        delete pk;
        return;
    }

    if (pk->hasPar("sourceId") && pk->hasPar("msgId")) {
        // duplicate control
        int moduleId = (int)pk->par("sourceId");
        int msgId = (int)pk->par("msgId");
        auto it = sourceSequence.find(moduleId);
        if (it != sourceSequence.end()) {
            if (it->second >= msgId) {
                EV_DEBUG << "Out of order packet: " << UDPSocket::getReceivedPacketInfo(pk) << endl;
                emit(outOfOrderPkSignal, pk);
                delete pk;
                numDuplicated++;
                return;
            }
            else
                it->second = msgId;
        }
        else
            sourceSequence[moduleId] = msgId;
    }

    if (delayLimit > 0) {
        if (simTime() - pk->getTimestamp() > delayLimit) {
            EV_DEBUG << "Old packet: " << UDPSocket::getReceivedPacketInfo(pk) << endl;
            emit(dropPkSignal, pk);
            delete pk;
            numDeleted++;
            return;
        }
    }

    EV_INFO << "Received packet: " << UDPSocket::getReceivedPacketInfo(pk) << endl;
    emit(rcvdPkSignal, pk);
    numReceived++;
    delete pk;
}

void inet::UDPBasicBurst::processSend ( )

protectedvirtual

Referenced by handleMessageWhenUp(), and processStart().

{
    if (stopTime < SIMTIME_ZERO || simTime() < stopTime) {
        // send and reschedule next sending
        if (isSource) // if the node is a sink, don't generate messages
            generateBurst();
    }
}

void inet::UDPBasicBurst::processStart ( )

protectedvirtual

Referenced by handleMessageWhenUp().

{
    socket.setOutputGate(gate("udpOut"));
    socket.bind(localPort);

    const char *destAddrs = par("destAddresses");
    cStringTokenizer tokenizer(destAddrs);
    const char *token;
    bool excludeLocalDestAddresses = par("excludeLocalDestAddresses").boolValue();

    IInterfaceTable *ift = getModuleFromPar<IInterfaceTable>(par("interfaceTableModule"), this);

    while ((token = tokenizer.nextToken()) != nullptr) {
        if (strstr(token, "Broadcast") != nullptr)
            destAddresses.push_back(IPv4Address::ALLONES_ADDRESS);
        else {
            L3Address addr = L3AddressResolver().resolve(token);
            if (excludeLocalDestAddresses && ift && ift->isLocalAddress(addr))
                continue;
            destAddresses.push_back(addr);
        }
    }

    nextSleep = simTime();
    nextBurst = simTime();
    nextPkt = simTime();
    activeBurst = false;

    isSource = !destAddresses.empty();

    if (isSource) {
        if (chooseDestAddrMode == ONCE)
            destAddr = chooseDestAddr();

        activeBurst = true;
    }
    timerNext->setKind(SEND);
    processSend();
}

void inet::UDPBasicBurst::processStop ( )

protectedvirtual

Referenced by handleMessageWhenUp().

{
    socket.close();
}

void inet::UDPBasicBurst::refreshDisplay ( ) const

overrideprotectedvirtual

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

Member Data Documentation

bool inet::UDPBasicBurst::activeBurst = false

protected

Referenced by generateBurst(), handleNodeCrash(), handleNodeShutdown(), and processStart().

cPar* inet::UDPBasicBurst::burstDurationPar = nullptr

protected

Referenced by generateBurst(), and initialize().

ChooseDestAddrMode inet::UDPBasicBurst::chooseDestAddrMode = (ChooseDestAddrMode)0

protected

Referenced by generateBurst(), initialize(), and processStart().

int inet::UDPBasicBurst::counter

staticprotected

Referenced by createPacket(), and initialize().

simtime_t inet::UDPBasicBurst::delayLimit

protected

Referenced by initialize(), and processPacket().

L3Address inet::UDPBasicBurst::destAddr

protected

Referenced by generateBurst(), and processStart().

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

protected

Referenced by chooseDestAddr(), and processStart().

int inet::UDPBasicBurst::destAddrRNG = -1

protected

Referenced by chooseDestAddr(), and initialize().

int inet::UDPBasicBurst::destPort = -1

protected

Referenced by generateBurst(), and initialize().

simsignal_t inet::UDPBasicBurst::dropPkSignal = registerSignal("dropPk")

staticprotected

Referenced by processPacket().

bool inet::UDPBasicBurst::haveSleepDuration = false

protected

bool inet::UDPBasicBurst::isSource = false

protected

Referenced by processSend(), and processStart().

int inet::UDPBasicBurst::localPort = -1

protected

Referenced by initialize(), and processStart().

cPar* inet::UDPBasicBurst::messageLengthPar = nullptr

protected

Referenced by createPacket(), and initialize().

simtime_t inet::UDPBasicBurst::nextBurst

protected

Referenced by generateBurst(), initialize(), and processStart().

simtime_t inet::UDPBasicBurst::nextPkt

protected

Referenced by generateBurst(), initialize(), and processStart().

simtime_t inet::UDPBasicBurst::nextSleep

protected

Referenced by generateBurst(), initialize(), and processStart().

int inet::UDPBasicBurst::numDeleted = 0

protected

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

int inet::UDPBasicBurst::numDuplicated = 0

protected

Referenced by initialize(), and processPacket().

int inet::UDPBasicBurst::numReceived = 0

protected

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

int inet::UDPBasicBurst::numSent = 0

protected

Referenced by createPacket(), finish(), generateBurst(), initialize(), and refreshDisplay().

simsignal_t inet::UDPBasicBurst::outOfOrderPkSignal = registerSignal("outOfOrderPk")

staticprotected

Referenced by processPacket().

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

staticprotected

Referenced by processPacket().

cPar* inet::UDPBasicBurst::sendIntervalPar = nullptr

protected

Referenced by generateBurst(), and initialize().

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

staticprotected

Referenced by generateBurst().

cPar* inet::UDPBasicBurst::sleepDurationPar = nullptr

protected

Referenced by generateBurst(), and initialize().

UDPSocket inet::UDPBasicBurst::socket

protected

Referenced by generateBurst(), processStart(), and processStop().

SourceSequence inet::UDPBasicBurst::sourceSequence

protected

Referenced by processPacket().

simtime_t inet::UDPBasicBurst::startTime

protected

Referenced by handleNodeStart(), and initialize().

simtime_t inet::UDPBasicBurst::stopTime

protected

Referenced by generateBurst(), handleNodeStart(), initialize(), and processSend().

cMessage* inet::UDPBasicBurst::timerNext = nullptr

protected

Referenced by generateBurst(), handleNodeCrash(), handleNodeShutdown(), handleNodeStart(), initialize(), processStart(), and ~UDPBasicBurst().

---

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

• UDPBasicBurst.h
• UDPBasicBurst.cc