inet::UDPSink Class Reference

Consumes and prints packets received from the UDP module. More...

#include <UDPSink.h>

Inheritance diagram for inet::UDPSink:

Public Member Functions
	UDPSink ()
virtual	~UDPSink ()
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, STOP }

Protected Member Functions
virtual void	processPacket (cPacket *msg)
virtual void	setSocketOptions ()
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	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
UDPSocket	socket
int	localPort = -1
L3Address	multicastGroup
simtime_t	startTime
simtime_t	stopTime
cMessage *	selfMsg = nullptr
int	numReceived = 0
Protected Attributes inherited from inet::OperationalBase
bool	isOperational
simtime_t	lastChange

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

Detailed Description

Consumes and prints packets received from the UDP module.

See NED for more info.

Member Enumeration Documentation

enum inet::UDPSink::SelfMsgKinds

protected

Enumerator
START
STOP

{ START = 1, STOP };

Constructor & Destructor Documentation

inet::UDPSink::UDPSink ( )

inline

{}

inet::UDPSink::~UDPSink ( )

virtual

{
    cancelAndDelete(selfMsg);
}

Member Function Documentation

void inet::UDPSink::finish ( )

overrideprotectedvirtual

{
    ApplicationBase::finish();
    EV_INFO << getFullPath() << ": received " << numReceived << " packets\n";
}

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

overrideprotectedvirtual

Implements inet::OperationalBase.

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

            case STOP:
                processStop();
                break;

            default:
                throw cRuntimeError("Invalid kind %d in self message", (int)selfMsg->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::UDPSink::handleNodeCrash ( )

overrideprotectedvirtual

Reimplemented from inet::OperationalBase.

{
    if (selfMsg)
        cancelEvent(selfMsg);
}

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

overrideprotectedvirtual

Reimplemented from inet::OperationalBase.

{
    if (selfMsg)
        cancelEvent(selfMsg);
    //TODO if(socket.isOpened()) socket.close();
    return true;
}

bool inet::UDPSink::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)) {
        selfMsg->setKind(START);
        scheduleAt(start, selfMsg);
    }
    return true;
}

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

overrideprotectedvirtual

Reimplemented from inet::OperationalBase.

{
    ApplicationBase::initialize(stage);

    if (stage == INITSTAGE_LOCAL) {
        numReceived = 0;
        WATCH(numReceived);

        localPort = par("localPort");
        startTime = par("startTime").doubleValue();
        stopTime = par("stopTime").doubleValue();
        if (stopTime >= SIMTIME_ZERO && stopTime < startTime)
            throw cRuntimeError("Invalid startTime/stopTime parameters");
        selfMsg = new cMessage("UDPSinkTimer");
    }
}

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

inlineoverrideprotectedvirtual

Reimplemented from inet::OperationalBase.

{ return NUM_INIT_STAGES; }

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

protectedvirtual

Referenced by handleMessageWhenUp().

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

    numReceived++;
}

void inet::UDPSink::processStart ( )

protectedvirtual

Referenced by handleMessageWhenUp().

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

    if (stopTime >= SIMTIME_ZERO) {
        selfMsg->setKind(STOP);
        scheduleAt(stopTime, selfMsg);
    }
}

void inet::UDPSink::processStop ( )

protectedvirtual

Referenced by handleMessageWhenUp().

{
    if (!multicastGroup.isUnspecified())
        socket.leaveMulticastGroup(multicastGroup); // FIXME should be done by socket.close()
    socket.close();
}

void inet::UDPSink::refreshDisplay ( ) const

overrideprotectedvirtual

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

void inet::UDPSink::setSocketOptions ( )

protectedvirtual

Referenced by processStart().

{
    bool receiveBroadcast = par("receiveBroadcast");
    if (receiveBroadcast)
        socket.setBroadcast(true);

    MulticastGroupList mgl = getModuleFromPar<IInterfaceTable>(par("interfaceTableModule"), this)->collectMulticastGroups();
    socket.joinLocalMulticastGroups(mgl);

    // join multicastGroup
    const char *groupAddr = par("multicastGroup");
    multicastGroup = L3AddressResolver().resolve(groupAddr);
    if (!multicastGroup.isUnspecified()) {
        if (!multicastGroup.isMulticast())
            throw cRuntimeError("Wrong multicastGroup setting: not a multicast address: %s", groupAddr);
        socket.joinMulticastGroup(multicastGroup);
    }
}

Member Data Documentation

int inet::UDPSink::localPort = -1

protected

Referenced by initialize(), and processStart().

L3Address inet::UDPSink::multicastGroup

protected

Referenced by processStop(), and setSocketOptions().

int inet::UDPSink::numReceived = 0

protected

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

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

staticprotected

Referenced by processPacket().

cMessage* inet::UDPSink::selfMsg = nullptr

protected

Referenced by handleMessageWhenUp(), handleNodeCrash(), handleNodeShutdown(), handleNodeStart(), initialize(), processStart(), and ~UDPSink().

UDPSocket inet::UDPSink::socket

protected

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

simtime_t inet::UDPSink::startTime

protected

Referenced by handleNodeStart(), and initialize().

simtime_t inet::UDPSink::stopTime

protected

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

---

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

• UDPSink.h
• UDPSink.cc