inet::EthernetSocketIo Class Reference

#include <EthernetSocketIo.h>

Inheritance diagram for inet::EthernetSocketIo:

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 (EthernetSocket *socket, Packet *packet) override
	Notifies about data arrival, packet ownership is transferred to the callee. More...
virtual void	socketErrorArrived (EthernetSocket *socket, Indication *indication) override
	Notifies about error indication arrival, indication ownership is transferred to the callee. More...
virtual void	socketClosed (EthernetSocket *socket) override
	Notifies about the socket closed. 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
MacAddress	remoteAddress
MacAddress	localAddress
EthernetSocket	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::EthernetSocket::ICallback
virtual	~ICallback ()
Protected Types inherited from inet::OperationalMixin< cSimpleModule >
enum	State

Member Function Documentation

finish()

void inet::EthernetSocketIo::finish ( )

overrideprotectedvirtual

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

handleCrashOperation()

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

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    socket.destroy();
}

handleMessageWhenUp()

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

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    if (socket.belongsToSocket(message))
        socket.processMessage(message);
    else {
        auto packet = check_and_cast<Packet *>(message);
        if (packet->findTag<PacketProtocolTag>() == nullptr) {
            auto packetProtocolTag = packet->addTag<PacketProtocolTag>();
            packetProtocolTag->setProtocol(&Protocol::unknown);
        }
        auto& macAddressReq = packet->addTag<MacAddressReq>();
        macAddressReq->setDestAddress(remoteAddress);
        socket.send(packet);
        numSent++;
        emit(packetSentSignal, packet);
    }
}

handleStartOperation()

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

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    setSocketOptions();
    socket.setOutputGate(gate("socketOut"));
// TODO breaks if there are queueing components between the application and the socket handling modules
//    socket.bind(localAddress, remoteAddress, nullptr, true);
}

handleStopOperation()

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

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

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

initialize()

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

overrideprotectedvirtual

Reimplemented from inet::OperationalMixin< cSimpleModule >.

{
    ApplicationBase::initialize(stage);
    if (stage == INITSTAGE_LOCAL) {
        numSent = 0;
        numReceived = 0;
        WATCH(numSent);
        WATCH(numReceived);
    }
    else if (stage == INITSTAGE_NETWORK_INTERFACE_CONFIGURATION + 1) {
        const char *localAddressString = par("localAddress");
        if (*localAddressString != '\0') {
            L3Address l3Address;
            L3AddressResolver addressResolver;
            addressResolver.tryResolve(localAddressString, l3Address, L3AddressResolver::ADDR_MAC);
            if (l3Address.getType() == L3Address::MAC)
                localAddress = l3Address.toMac();
            else
                localAddress = MacAddress(localAddressString);
        }
        const char *remoteAddressString = par("remoteAddress");
        if (*remoteAddressString != '\0') {
            L3Address l3Address;
            L3AddressResolver addressResolver;
            addressResolver.tryResolve(remoteAddressString, l3Address, L3AddressResolver::ADDR_MAC);
            if (l3Address.getType() == L3Address::MAC)
                remoteAddress = l3Address.toMac();
            else
                remoteAddress = MacAddress(remoteAddressString);
        }
    }
}

numInitStages()

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

inlineoverrideprotectedvirtual

{ return NUM_INIT_STAGES; }

refreshDisplay()

void inet::EthernetSocketIo::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::EthernetSocketIo::setSocketOptions ( )

protectedvirtual

{
    socket.setCallback(this);
    const char *interface = par("interface");
    if (interface[0] != '\0') {
        auto interfaceTable = getModuleFromPar<IInterfaceTable>(par("interfaceTableModule"), this);
        auto networkInterface = interfaceTable->findInterfaceByName(interface);
        if (networkInterface == nullptr)
            throw cRuntimeError("Cannot find network interface");
        socket.setNetworkInterface(networkInterface);
    }
}

Referenced by handleStartOperation().

socketClosed()

void inet::EthernetSocketIo::socketClosed ( EthernetSocket *  socket )

overrideprotectedvirtual

Notifies about the socket closed.

Implements inet::EthernetSocket::ICallback.

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

socketDataArrived()

void inet::EthernetSocketIo::socketDataArrived ( EthernetSocket *  socket, Packet *  packet  )

overrideprotectedvirtual

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

Implements inet::EthernetSocket::ICallback.

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

socketErrorArrived()

void inet::EthernetSocketIo::socketErrorArrived ( EthernetSocket *  socket, Indication *  indication  )

overrideprotectedvirtual

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

Implements inet::EthernetSocket::ICallback.

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

Member Data Documentation

localAddress

MacAddress inet::EthernetSocketIo::localAddress

protected

Referenced by initialize().

numReceived

int inet::EthernetSocketIo::numReceived = 0

protected

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

numSent

int inet::EthernetSocketIo::numSent = 0

protected

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

remoteAddress

MacAddress inet::EthernetSocketIo::remoteAddress

protected

Referenced by handleMessageWhenUp(), and initialize().

socket

EthernetSocket inet::EthernetSocketIo::socket

protected

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

---

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

• EthernetSocketIo.h
• EthernetSocketIo.cc