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

Protected Types
enum	SelfMsgKinds { START = 1, SEND, STOP }
typedef std::map< int, int >	SourceSequence
Protected Types inherited from inet::OperationalMixin< cSimpleModule >
enum	State

Protected Member Functions
virtual L3Address	chooseDestAddr ()
virtual Packet *	createPacket ()
virtual void	processPacket (Packet *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 void	handleStartOperation (LifecycleOperation *operation) override
virtual void	handleStopOperation (LifecycleOperation *operation) override
virtual void	handleCrashOperation (LifecycleOperation *operation) override
virtual void	socketDataArrived (UdpSocket *socket, Packet *packet) override
	Notifies about data arrival, packet ownership is transferred to the callee. More...
virtual void	socketErrorArrived (UdpSocket *socket, Indication *indication) override
	Notifies about error indication arrival, indication ownership is transferred to the callee. More...
virtual void	socketClosed (UdpSocket *socket) override
	Notifies about socket closed, indication ownership is transferred to the callee. More...
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
std::vector< L3Address >	destAddresses
ChooseDestAddrMode	chooseDestAddrMode = static_cast<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
bool	dontFragment = false
int	numSent = 0
int	numReceived = 0
int	numDeleted = 0
int	numDuplicated = 0
Protected Attributes inherited from inet::OperationalMixin< cSimpleModule >
State	operationalState
simtime_t	lastChange
Operation	activeOperation
cMessage *	activeOperationTimeout
cMessage *	activeOperationExtraTimer

Static Protected Attributes
static int	counter
static simsignal_t	outOfOrderPkSignal = registerSignal("outOfOrderPk")

Detailed Description

UDP application.

See NED for more info.

Member Typedef Documentation

SourceSequence

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

protected

Member Enumeration Documentation

ChooseDestAddrMode

enum inet::UdpBasicBurst::ChooseDestAddrMode

Enumerator
ONCE
PER_BURST
PER_SEND

                            {
        ONCE = 1, PER_BURST, PER_SEND
    };

SelfMsgKinds

enum inet::UdpBasicBurst::SelfMsgKinds

protected

Enumerator
START
SEND
STOP

{ START = 1, SEND, STOP };

Constructor & Destructor Documentation

UdpBasicBurst()

inet::UdpBasicBurst::UdpBasicBurst ( )

inline

{}

~UdpBasicBurst()

inet::UdpBasicBurst::~UdpBasicBurst

(

)

{
    cancelAndDelete(timerNext);
}

Member Function Documentation

chooseDestAddr()

L3Address inet::UdpBasicBurst::chooseDestAddr ( )

protectedvirtual

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

Referenced by generateBurst(), and processStart().

createPacket()

Packet * inet::UdpBasicBurst::createPacket ( )

protectedvirtual

{
    char msgName[32];
    sprintf(msgName, "UDPBasicAppData-%d", counter++);
    long msgByteLength = *messageLengthPar;
    Packet *pk = new Packet(msgName);
    const auto& payload = makeShared<ApplicationPacket>();
    payload->setChunkLength(B(msgByteLength));
    payload->setSequenceNumber(numSent);
    payload->addTag<CreationTimeTag>()->setCreationTime(simTime());
    pk->insertAtBack(payload);
    pk->addPar("sourceId") = getId();
    pk->addPar("msgId") = numSent;
 
    return pk;
}

Referenced by generateBurst().

finish()

void inet::UdpBasicBurst::finish ( )

overrideprotectedvirtual

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

generateBurst()

void inet::UdpBasicBurst::generateBurst ( )

protectedvirtual

{
    simtime_t now = simTime();
 
    if (nextPkt < now)
        nextPkt = now;
 
    double sendInterval = *sendIntervalPar;
    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;
        if (burstDuration < 0.0)
            throw cRuntimeError("The burstDuration parameter mustn't be smaller than 0");
        double sleepDuration = *sleepDurationPar;
 
        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();
 
    Packet *payload = createPacket();
    if (dontFragment)
        payload->addTag<FragmentationReq>()->setDontFragment(true);
    payload->setTimestamp();
    emit(packetSentSignal, 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);
}

Referenced by processSend().

handleCrashOperation()

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

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    if (timerNext)
        cancelEvent(timerNext);
    activeBurst = false;
    if (operation->getRootModule() != getContainingNode(this)) // closes socket when the application crashed only
        socket.destroy(); // TODO  in real operating systems, program crash detected by OS and OS closes sockets of crashed programs.
}

handleMessageWhenUp()

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

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    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
        socket.processMessage(msg);
}

handleStartOperation()

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

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

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

handleStopOperation()

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

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    if (timerNext)
        cancelEvent(timerNext);
    activeBurst = false;
    socket.close();
    delayActiveOperationFinish(par("stopOperationTimeout"));
}

initialize()

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

overrideprotectedvirtual

Reimplemented from inet::OperationalMixin< cSimpleModule >.

{
    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;
        dontFragment = par("dontFragment");
 
        destAddrRNG = par("destAddrRNG");
        const char *addrModeStr = par("chooseDestAddrMode");
        int addrMode = cEnum::get("inet::ChooseDestAddrMode")->lookup(addrModeStr);
        if (addrMode == -1)
            throw cRuntimeError("Invalid chooseDestAddrMode: '%s'", addrModeStr);
        chooseDestAddrMode = static_cast<ChooseDestAddrMode>(addrMode);
 
        WATCH(numSent);
        WATCH(numReceived);
        WATCH(numDeleted);
        WATCH(numDuplicated);
 
        localPort = par("localPort");
        destPort = par("destPort");
 
        timerNext = new cMessage("UDPBasicBurstTimer");
    }
}

numInitStages()

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

inlineoverrideprotectedvirtual

{ return NUM_INIT_STAGES; }

processPacket()

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

protectedvirtual

{
    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 = pk->par("sourceId");
        int msgId = 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;
            PacketDropDetails details;
            details.setReason(CONGESTION);
            emit(packetDroppedSignal, pk, &details);
            delete pk;
            numDeleted++;
            return;
        }
    }
 
    EV_INFO << "Received packet: " << UdpSocket::getReceivedPacketInfo(pk) << endl;
    emit(packetReceivedSignal, pk);
    numReceived++;
    delete pk;
}

Referenced by socketDataArrived().

processSend()

void inet::UdpBasicBurst::processSend ( )

protectedvirtual

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

Referenced by handleMessageWhenUp(), and processStart().

processStart()

void inet::UdpBasicBurst::processStart ( )

protectedvirtual

{
    socket.setOutputGate(gate("socketOut"));
    socket.setCallback(this);
    socket.bind(localPort);
 
    int timeToLive = par("timeToLive");
    if (timeToLive != -1)
        socket.setTimeToLive(timeToLive);
 
    int dscp = par("dscp");
    if (dscp != -1)
        socket.setDscp(dscp);
 
    int tos = par("tos");
    if (tos != -1)
        socket.setTos(tos);
 
    const char *destAddrs = par("destAddresses");
    cStringTokenizer tokenizer(destAddrs);
    const char *token;
    bool excludeLocalDestAddresses = par("excludeLocalDestAddresses");
 
    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();
}

Referenced by handleMessageWhenUp().

processStop()

void inet::UdpBasicBurst::processStop ( )

protectedvirtual

{
    socket.close();
    socket.setCallback(nullptr);
}

Referenced by handleMessageWhenUp().

refreshDisplay()

void inet::UdpBasicBurst::refreshDisplay ( ) const

overrideprotectedvirtual

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

socketClosed()

void inet::UdpBasicBurst::socketClosed ( UdpSocket *  socket )

overrideprotectedvirtual

Notifies about socket closed, indication ownership is transferred to the callee.

Implements inet::UdpSocket::ICallback.

{
    if (operationalState == State::STOPPING_OPERATION)
        startActiveOperationExtraTimeOrFinish(par("stopOperationExtraTime"));
}

socketDataArrived()

void inet::UdpBasicBurst::socketDataArrived ( UdpSocket *  socket, Packet *  packet  )

overrideprotectedvirtual

Notifies about data arrival, packet ownership is transferred to the callee.

Implements inet::UdpSocket::ICallback.

{
    // process incoming packet
    processPacket(packet);
}

socketErrorArrived()

void inet::UdpBasicBurst::socketErrorArrived ( UdpSocket *  socket, Indication *  indication  )

overrideprotectedvirtual

Notifies about error indication arrival, indication ownership is transferred to the callee.

Implements inet::UdpSocket::ICallback.

{
    EV_WARN << "Ignoring UDP error report " << indication->getName() << endl;
    delete indication;
}

Member Data Documentation

activeBurst

bool inet::UdpBasicBurst::activeBurst = false

protected

Referenced by generateBurst(), handleCrashOperation(), handleStopOperation(), and processStart().

burstDurationPar

cPar* inet::UdpBasicBurst::burstDurationPar = nullptr

protected

Referenced by generateBurst(), and initialize().

chooseDestAddrMode

ChooseDestAddrMode inet::UdpBasicBurst::chooseDestAddrMode = static_cast<ChooseDestAddrMode>(0)

protected

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

counter

int inet::UdpBasicBurst::counter

staticprotected

Referenced by createPacket(), and initialize().

delayLimit

simtime_t inet::UdpBasicBurst::delayLimit

protected

Referenced by initialize(), and processPacket().

destAddr

L3Address inet::UdpBasicBurst::destAddr

protected

Referenced by generateBurst(), and processStart().

destAddresses

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

protected

Referenced by chooseDestAddr(), and processStart().

destAddrRNG

int inet::UdpBasicBurst::destAddrRNG = -1

protected

Referenced by chooseDestAddr(), and initialize().

destPort

int inet::UdpBasicBurst::destPort = -1

protected

Referenced by generateBurst(), and initialize().

dontFragment

bool inet::UdpBasicBurst::dontFragment = false

protected

Referenced by generateBurst(), and initialize().

haveSleepDuration

bool inet::UdpBasicBurst::haveSleepDuration = false

protected

isSource

bool inet::UdpBasicBurst::isSource = false

protected

Referenced by processSend(), and processStart().

localPort

int inet::UdpBasicBurst::localPort = -1

protected

Referenced by initialize(), and processStart().

messageLengthPar

cPar* inet::UdpBasicBurst::messageLengthPar = nullptr

protected

Referenced by createPacket(), and initialize().

nextBurst

simtime_t inet::UdpBasicBurst::nextBurst

protected

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

nextPkt

simtime_t inet::UdpBasicBurst::nextPkt

protected

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

nextSleep

simtime_t inet::UdpBasicBurst::nextSleep

protected

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

numDeleted

int inet::UdpBasicBurst::numDeleted = 0

protected

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

numDuplicated

int inet::UdpBasicBurst::numDuplicated = 0

protected

Referenced by initialize(), and processPacket().

numReceived

int inet::UdpBasicBurst::numReceived = 0

protected

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

numSent

int inet::UdpBasicBurst::numSent = 0

protected

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

outOfOrderPkSignal

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

staticprotected

Referenced by processPacket().

sendIntervalPar

cPar* inet::UdpBasicBurst::sendIntervalPar = nullptr

protected

Referenced by generateBurst(), and initialize().

sleepDurationPar

cPar* inet::UdpBasicBurst::sleepDurationPar = nullptr

protected

Referenced by generateBurst(), and initialize().

socket

UdpSocket inet::UdpBasicBurst::socket

protected

Referenced by generateBurst(), handleCrashOperation(), handleMessageWhenUp(), handleStopOperation(), processStart(), and processStop().

sourceSequence

SourceSequence inet::UdpBasicBurst::sourceSequence

protected

Referenced by processPacket().

startTime

simtime_t inet::UdpBasicBurst::startTime

protected

Referenced by handleStartOperation(), and initialize().

stopTime

simtime_t inet::UdpBasicBurst::stopTime

protected

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

timerNext

cMessage* inet::UdpBasicBurst::timerNext = nullptr

protected

Referenced by generateBurst(), handleCrashOperation(), handleStartOperation(), handleStopOperation(), initialize(), processStart(), and ~UdpBasicBurst().

---

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

• UdpBasicBurst.h
• UdpBasicBurst.cc