inet::UdpSocketIo Class Reference

#include <UdpSocketIo.h>

Inheritance diagram for inet::UdpSocketIo:

Protected Member Functions
virtual int	numInitStages () const override
virtual void	initialize (int stage) override
virtual void	handleMessageWhenUp (cMessage *message) override
virtual void	finish () override
virtual void	refreshDisplay () const override
virtual void	setSocketOptions ()
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...
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
bool	dontFragment = false
UdpSocket	socket
int	numSent = 0
int	numReceived = 0
Protected Attributes inherited from inet::OperationalMixin< cSimpleModule >
State	operationalState
simtime_t	lastChange
Operation	activeOperation
cMessage *	activeOperationTimeout
cMessage *	activeOperationExtraTimer

Additional Inherited Members
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 inherited from inet::OperationalMixin< cSimpleModule >
enum	State

Member Function Documentation

finish()

void inet::UdpSocketIo::finish ( )

overrideprotectedvirtual

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

handleCrashOperation()

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

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    socket.destroy();
}

handleMessageWhenUp()

void inet::UdpSocketIo::handleMessageWhenUp ( cMessage *  message )

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    if (socket.belongsToSocket(message))
        socket.processMessage(message);
    else {
        auto packet = check_and_cast<Packet *>(message);
        if (dontFragment)
            packet->addTagIfAbsent<FragmentationReq>()->setDontFragment(true);
        socket.send(packet);
        numSent++;
        emit(packetSentSignal, packet);
    }
}

handleStartOperation()

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

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    socket.setOutputGate(gate("socketOut"));
    setSocketOptions();
    const char *localAddress = par("localAddress");
    socket.bind(*localAddress ? L3AddressResolver().resolve(localAddress) : L3Address(), par("localPort"));
    const char *destAddrs = par("destAddress");
    if (*destAddrs)
        socket.connect(L3AddressResolver().resolve(destAddrs), par("destPort"));
}

handleStopOperation()

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

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

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

initialize()

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

overrideprotectedvirtual

Reimplemented from inet::OperationalMixin< cSimpleModule >.

{
    ApplicationBase::initialize(stage);
    if (stage == INITSTAGE_LOCAL) {
        dontFragment = par("dontFragment");
        numSent = 0;
        numReceived = 0;
        WATCH(numSent);
        WATCH(numReceived);
    }
}

numInitStages()

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

inlineoverrideprotectedvirtual

{ return NUM_INIT_STAGES; }

refreshDisplay()

void inet::UdpSocketIo::refreshDisplay ( ) const

overrideprotectedvirtual

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

setSocketOptions()

void inet::UdpSocketIo::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);
 
    NetworkInterface *multicastInterface = nullptr;
    const char *multicastInterfaceName = par("multicastInterface");
    if (multicastInterfaceName[0]) {
        IInterfaceTable *ift = getModuleFromPar<IInterfaceTable>(par("interfaceTableModule"), this);
        multicastInterface = ift->findInterfaceByName(multicastInterfaceName);
        if (!multicastInterface)
            throw cRuntimeError("Wrong multicastInterface setting: no interface named \"%s\"", multicastInterfaceName);
        socket.setMulticastOutputInterface(multicastInterface->getInterfaceId());
    }
 
    auto multicastAddresses = check_and_cast<cValueArray *>(par("multicastAddresses").objectValue());
    for (int i = 0; i < multicastAddresses->size(); i++)
        socket.joinMulticastGroup(Ipv4Address(multicastAddresses->get(0).stringValue()), multicastInterface != nullptr ? multicastInterface->getInterfaceId() : -1);
 
    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 handleStartOperation().

socketClosed()

void inet::UdpSocketIo::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::UdpSocketIo::socketDataArrived ( UdpSocket *  socket, Packet *  packet  )

overrideprotectedvirtual

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

Implements inet::UdpSocket::ICallback.

{
    emit(packetReceivedSignal, packet);
    EV_INFO << "Received packet: " << UdpSocket::getReceivedPacketInfo(packet) << endl;
    numReceived++;
    packet->removeTag<SocketInd>();
    send(packet, "trafficOut");
}

socketErrorArrived()

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

dontFragment

bool inet::UdpSocketIo::dontFragment = false

protected

Referenced by handleMessageWhenUp(), and initialize().

numReceived

int inet::UdpSocketIo::numReceived = 0

protected

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

numSent

int inet::UdpSocketIo::numSent = 0

protected

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

socket

UdpSocket inet::UdpSocketIo::socket

protected

Referenced by handleCrashOperation(), handleMessageWhenUp(), handleStartOperation(), handleStopOperation(), and setSocketOptions().

---

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

• UdpSocketIo.h
• UdpSocketIo.cc