inet::UdpBasicApp Class Reference

UDP application. More...

#include <UdpBasicApp.h>

Inheritance diagram for inet::UdpBasicApp:

Public Member Functions
	UdpBasicApp ()
	~UdpBasicApp ()
Public Member Functions inherited from inet::ClockUserModuleMixin< ApplicationBase >
virtual void	scheduleClockEventAt (clocktime_t time, ClockEvent *msg)
virtual void	scheduleClockEventAfter (clocktime_t delay, ClockEvent *msg)
virtual cMessage *	cancelClockEvent (ClockEvent *msg)
virtual void	cancelAndDeleteClockEvent (ClockEvent *msg)
virtual void	rescheduleClockEventAt (clocktime_t time, ClockEvent *msg)
virtual void	rescheduleClockEventAfter (clocktime_t time, ClockEvent *msg)
virtual clocktime_t	computeClockTimeFromSimTime (simtime_t time) const
virtual simtime_t	computeSimTimeFromClockTime (clocktime_t time) const
virtual clocktime_t	getClockTime () const
virtual clocktime_t	getArrivalClockTime (ClockEvent *msg) const
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 }
Protected Types inherited from inet::OperationalMixin< cSimpleModule >
enum	State

Protected Member Functions
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 L3Address	chooseDestAddr ()
virtual void	sendPacket ()
virtual void	processPacket (Packet *msg)
virtual void	setSocketOptions ()
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
std::vector< std::string >	destAddressStr
int	localPort = -1
int	destPort = -1
clocktime_t	startTime
clocktime_t	stopTime
bool	dontFragment = false
const char *	packetName = nullptr
UdpSocket	socket
ClockEvent *	selfMsg = 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

Detailed Description

UDP application.

See NED for more info.

Member Enumeration Documentation

SelfMsgKinds

enum inet::UdpBasicApp::SelfMsgKinds

protected

Enumerator
START
SEND
STOP

{ START = 1, SEND, STOP };

Constructor & Destructor Documentation

UdpBasicApp()

inet::UdpBasicApp::UdpBasicApp ( )

inline

{}

~UdpBasicApp()

inet::UdpBasicApp::~UdpBasicApp

(

)

{
    cancelAndDelete(selfMsg);
}

Member Function Documentation

chooseDestAddr()

L3Address inet::UdpBasicApp::chooseDestAddr ( )

protectedvirtual

{
    int k = intrand(destAddresses.size());
    if (destAddresses[k].isUnspecified() || destAddresses[k].isLinkLocal()) {
        L3AddressResolver().tryResolve(destAddressStr[k].c_str(), destAddresses[k]);
    }
    return destAddresses[k];
}

Referenced by sendPacket().

finish()

void inet::UdpBasicApp::finish ( )

overrideprotectedvirtual

{
    recordScalar("packets sent", numSent);
    recordScalar("packets received", numReceived);
    ApplicationBase::finish();
}

handleCrashOperation()

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

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    cancelClockEvent(selfMsg);
    socket.destroy(); // TODO  in real operating systems, program crash detected by OS and OS closes sockets of crashed programs.
}

handleMessageWhenUp()

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

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    if (msg->isSelfMessage()) {
        ASSERT(msg == selfMsg);
        switch (selfMsg->getKind()) {
            case START:
                processStart();
                break;
 
            case SEND:
                processSend();
                break;
 
            case STOP:
                processStop();
                break;
 
            default:
                throw cRuntimeError("Invalid kind %d in self message", (int)selfMsg->getKind());
        }
    }
    else
        socket.processMessage(msg);
}

handleStartOperation()

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

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    clocktime_t start = std::max(startTime, getClockTime());
    if ((stopTime < CLOCKTIME_ZERO) || (start < stopTime) || (start == stopTime && startTime == stopTime)) {
        selfMsg->setKind(START);
        scheduleClockEventAt(start, selfMsg);
    }
}

handleStopOperation()

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

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    cancelEvent(selfMsg);
    socket.close();
    delayActiveOperationFinish(par("stopOperationTimeout"));
}

initialize()

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

overrideprotectedvirtual

Reimplemented from inet::OperationalMixin< cSimpleModule >.

{
    ClockUserModuleMixin::initialize(stage);
 
    if (stage == INITSTAGE_LOCAL) {
        numSent = 0;
        numReceived = 0;
        WATCH(numSent);
        WATCH(numReceived);
 
        localPort = par("localPort");
        destPort = par("destPort");
        startTime = par("startTime");
        stopTime = par("stopTime");
        packetName = par("packetName");
        dontFragment = par("dontFragment");
        if (stopTime >= CLOCKTIME_ZERO && stopTime < startTime)
            throw cRuntimeError("Invalid startTime/stopTime parameters");
        selfMsg = new ClockEvent("sendTimer");
    }
}

numInitStages()

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

inlineoverrideprotectedvirtual

{ return NUM_INIT_STAGES; }

processPacket()

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

protectedvirtual

{
    emit(packetReceivedSignal, pk);
    EV_INFO << "Received packet: " << UdpSocket::getReceivedPacketInfo(pk) << endl;
    delete pk;
    numReceived++;
}

Referenced by socketDataArrived().

processSend()

void inet::UdpBasicApp::processSend ( )

protectedvirtual

{
    sendPacket();
    clocktime_t d = par("sendInterval");
    if (stopTime < CLOCKTIME_ZERO || getClockTime() + d < stopTime) {
        selfMsg->setKind(SEND);
        scheduleClockEventAfter(d, selfMsg);
    }
    else {
        selfMsg->setKind(STOP);
        scheduleClockEventAt(stopTime, selfMsg);
    }
}

Referenced by handleMessageWhenUp(), and processStart().

processStart()

void inet::UdpBasicApp::processStart ( )

protectedvirtual

{
    socket.setOutputGate(gate("socketOut"));
    const char *localAddress = par("localAddress");
    socket.bind(*localAddress ? L3AddressResolver().resolve(localAddress) : L3Address(), localPort);
    setSocketOptions();
 
    const char *destAddrs = par("destAddresses");
    cStringTokenizer tokenizer(destAddrs);
    const char *token;
 
    while ((token = tokenizer.nextToken()) != nullptr) {
        destAddressStr.push_back(token);
        L3Address result;
        L3AddressResolver().tryResolve(token, result);
        if (result.isUnspecified())
            EV_ERROR << "cannot resolve destination address: " << token << endl;
        destAddresses.push_back(result);
    }
 
    if (!destAddresses.empty()) {
        selfMsg->setKind(SEND);
        processSend();
    }
    else {
        if (stopTime >= CLOCKTIME_ZERO) {
            selfMsg->setKind(STOP);
            scheduleClockEventAt(stopTime, selfMsg);
        }
    }
}

Referenced by handleMessageWhenUp().

processStop()

void inet::UdpBasicApp::processStop ( )

protectedvirtual

{
    socket.close();
}

Referenced by handleMessageWhenUp().

refreshDisplay()

void inet::UdpBasicApp::refreshDisplay ( ) const

overrideprotectedvirtual

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

sendPacket()

void inet::UdpBasicApp::sendPacket ( )

protectedvirtual

{
    std::ostringstream str;
    str << packetName << "-" << numSent;
    Packet *packet = new Packet(str.str().c_str());
    if (dontFragment)
        packet->addTag<FragmentationReq>()->setDontFragment(true);
    const auto& payload = makeShared<ApplicationPacket>();
    payload->setChunkLength(B(par("messageLength")));
    payload->setSequenceNumber(numSent);
    payload->addTag<CreationTimeTag>()->setCreationTime(simTime());
    packet->insertAtBack(payload);
    L3Address destAddr = chooseDestAddr();
    emit(packetSentSignal, packet);
    socket.sendTo(packet, destAddr, destPort);
    numSent++;
}

Referenced by processSend().

setSocketOptions()

void inet::UdpBasicApp::setSocketOptions ( )

protectedvirtual

{
    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 *multicastInterface = par("multicastInterface");
    if (multicastInterface[0]) {
        IInterfaceTable *ift = getModuleFromPar<IInterfaceTable>(par("interfaceTableModule"), this);
        NetworkInterface *ie = ift->findInterfaceByName(multicastInterface);
        if (!ie)
            throw cRuntimeError("Wrong multicastInterface setting: no interface named \"%s\"", multicastInterface);
        socket.setMulticastOutputInterface(ie->getInterfaceId());
    }
 
    bool receiveBroadcast = par("receiveBroadcast");
    if (receiveBroadcast)
        socket.setBroadcast(true);
 
    bool joinLocalMulticastGroups = par("joinLocalMulticastGroups");
    if (joinLocalMulticastGroups) {
        MulticastGroupList mgl = getModuleFromPar<IInterfaceTable>(par("interfaceTableModule"), this)->collectMulticastGroups();
        socket.joinLocalMulticastGroups(mgl);
    }
    socket.setCallback(this);
}

Referenced by processStart().

socketClosed()

void inet::UdpBasicApp::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::UdpBasicApp::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::UdpBasicApp::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

destAddresses

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

protected

Referenced by chooseDestAddr(), and processStart().

destAddressStr

std::vector<std::string> inet::UdpBasicApp::destAddressStr

protected

Referenced by chooseDestAddr(), and processStart().

destPort

int inet::UdpBasicApp::destPort = -1

protected

Referenced by initialize(), and sendPacket().

dontFragment

bool inet::UdpBasicApp::dontFragment = false

protected

Referenced by initialize(), and sendPacket().

localPort

int inet::UdpBasicApp::localPort = -1

protected

Referenced by initialize(), and processStart().

numReceived

int inet::UdpBasicApp::numReceived = 0

protected

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

numSent

int inet::UdpBasicApp::numSent = 0

protected

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

packetName

const char* inet::UdpBasicApp::packetName = nullptr

protected

Referenced by initialize(), and sendPacket().

selfMsg

ClockEvent* inet::UdpBasicApp::selfMsg = nullptr

protected

Referenced by handleCrashOperation(), handleMessageWhenUp(), handleStartOperation(), handleStopOperation(), initialize(), processSend(), processStart(), and ~UdpBasicApp().

socket

UdpSocket inet::UdpBasicApp::socket

protected

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

startTime

clocktime_t inet::UdpBasicApp::startTime

protected

Referenced by handleStartOperation(), and initialize().

stopTime

clocktime_t inet::UdpBasicApp::stopTime

protected

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

---

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

• UdpBasicApp.h
• UdpBasicApp.cc