inet::TunnelApp Class Reference

#include <TunnelApp.h>

Inheritance diagram for inet::TunnelApp:

Public Member Functions
	TunnelApp ()
virtual	~TunnelApp ()
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 ()
Public Member Functions inherited from inet::Ipv4Socket::ICallback
virtual void	socketDataArrived (INetworkSocket *socket, Packet *packet) override
virtual void	socketClosed (INetworkSocket *socket) override
	Notifies about socket closed, indication ownership is transferred to the callee. More...
Public Member Functions inherited from inet::INetworkSocket::ICallback
virtual	~ICallback ()
Public Member Functions inherited from inet::TunSocket::ICallback
virtual	~ICallback ()

Protected Member Functions
virtual int	numInitStages () const override
virtual void	initialize (int stage) override
virtual void	handleMessageWhenUp (cMessage *msg) 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...
virtual void	socketDataArrived (Ipv4Socket *socket, Packet *packet) override
virtual void	socketClosed (Ipv4Socket *socket) override
virtual void	socketDataArrived (TunSocket *socket, Packet *packet) override
virtual void	socketClosed (TunSocket *socket) override
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
const Protocol *	protocol = nullptr
const char *	interface = nullptr
const char *	destinationAddress = nullptr
int	destinationPort = -1
int	localPort = -1
Ipv4Socket	ipv4Socket
UdpSocket	serverSocket
UdpSocket	clientSocket
TunSocket	tunSocket
SocketMap	socketMap
Protected Attributes inherited from inet::OperationalMixin< cSimpleModule >
State	operationalState
simtime_t	lastChange
Operation	activeOperation
cMessage *	activeOperationTimeout
cMessage *	activeOperationExtraTimer

Additional Inherited Members
Protected Types inherited from inet::OperationalMixin< cSimpleModule >
enum	State

Constructor & Destructor Documentation

TunnelApp()

inet::TunnelApp::TunnelApp

(

)

{
}

~TunnelApp()

inet::TunnelApp::~TunnelApp ( )

virtual

{
}

Member Function Documentation

handleCrashOperation()

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

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    ipv4Socket.destroy();
    serverSocket.destroy();
    clientSocket.destroy();
    for (auto s : socketMap.getMap())
        s.second->destroy();
    socketMap.deleteSockets();
}

handleMessageWhenUp()

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

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    if (message->arrivedOn("socketIn")) {
        ASSERT(message->getControlInfo() == nullptr);
 
        if (auto socket = socketMap.findSocketFor(message)) {
            socket->processMessage(message);
        }
        else
            throw cRuntimeError("Unknown message: %s", message->getName());
    }
    else
        throw cRuntimeError("Message arrived on unknown gate %s", message->getArrivalGate()->getFullName());
 
    if (operationalState == State::STOPPING_OPERATION) {
        if (ipv4Socket.isOpen() || serverSocket.isOpen() || clientSocket.isOpen())
            return;
        for (auto s : socketMap.getMap())
            if (s.second->isOpen())
                return;
        socketMap.deleteSockets();
        startActiveOperationExtraTimeOrFinish(par("stopOperationExtraTime"));
    }
}

handleStartOperation()

virtual void inet::TunnelApp::handleStartOperation ( LifecycleOperation *  operation )

inlineoverrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{} // TODO implementation

handleStopOperation()

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

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    ipv4Socket.close();
    serverSocket.close();
    clientSocket.close();
    for (auto s : socketMap.getMap())
        s.second->close();
    delayActiveOperationFinish(par("stopOperationTimeout"));
}

initialize()

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

overrideprotectedvirtual

Reimplemented from inet::OperationalMixin< cSimpleModule >.

{
    ApplicationBase::initialize(stage);
    if (stage == INITSTAGE_LOCAL) {
        interface = par("interface");
        const char *protocolName = par("protocol");
        protocol = Protocol::getProtocol(protocolName);
        destinationAddress = par("destinationAddress");
        if (protocol == &Protocol::udp) {
            destinationPort = par("destinationPort");
            localPort = par("localPort");
        }
    }
    else if (stage == INITSTAGE_APPLICATION_LAYER) {
        if (protocol == &Protocol::ipv4) {
            ipv4Socket.setOutputGate(gate("socketOut"));
            ipv4Socket.bind(&Protocol::ipv4, Ipv4Address::UNSPECIFIED_ADDRESS);
            ipv4Socket.setCallback(this);
            socketMap.addSocket(&ipv4Socket);
        }
        if (protocol == &Protocol::udp) {
            serverSocket.setOutputGate(gate("socketOut"));
            if (localPort != -1)
                serverSocket.bind(localPort);
            clientSocket.setOutputGate(gate("socketOut"));
            if (destinationPort != -1)
                clientSocket.connect(L3AddressResolver().resolve(destinationAddress), destinationPort);
            clientSocket.setCallback(this);
            serverSocket.setCallback(this);
            socketMap.addSocket(&clientSocket);
            socketMap.addSocket(&serverSocket);
        }
        IInterfaceTable *interfaceTable = getModuleFromPar<IInterfaceTable>(par("interfaceTableModule"), this);
        NetworkInterface *networkInterface = interfaceTable->findInterfaceByName(interface);
        if (networkInterface == nullptr)
            throw cRuntimeError("TUN interface not found: %s", interface);
        tunSocket.setOutputGate(gate("socketOut"));
        tunSocket.open(networkInterface->getInterfaceId());
        tunSocket.setCallback(this);
        socketMap.addSocket(&tunSocket);
    }
}

numInitStages()

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

inlineoverrideprotectedvirtual

{ return NUM_INIT_STAGES; }

socketClosed() [1/3]

void inet::TunnelApp::socketClosed ( Ipv4Socket *  socket )

overrideprotectedvirtual

Implements inet::Ipv4Socket::ICallback.

{
    // TODO processing socket closed at stopOperation
}

socketClosed() [2/3]

virtual void inet::TunnelApp::socketClosed ( TunSocket *  socket )

inlineoverrideprotectedvirtual

Implements inet::TunSocket::ICallback.

{}

socketClosed() [3/3]

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

overrideprotectedvirtual

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

Implements inet::UdpSocket::ICallback.

{
    // TODO processing socket closed at stopOperation
}

socketDataArrived() [1/3]

void inet::TunnelApp::socketDataArrived ( Ipv4Socket *  socket, Packet *  packet  )

overrideprotectedvirtual

Implements inet::Ipv4Socket::ICallback.

{
    auto packetProtocol = packet->getTag<NetworkProtocolInd>()->getProtocol();
    if (protocol == packetProtocol) {
        packet->clearTags();
        tunSocket.send(packet);
    }
    else
        throw cRuntimeError("Unknown protocol: %s", packetProtocol->getName());
}

socketDataArrived() [2/3]

void inet::TunnelApp::socketDataArrived ( TunSocket *  socket, Packet *  packet  )

overrideprotectedvirtual

Implements inet::TunSocket::ICallback.

{
    // InterfaceInd says packet is from tunnel interface and socket id is present and equals to tunSocket
    if (protocol == &Protocol::ipv4) {
        packet->clearTags();
        packet->addTag<L3AddressReq>()->setDestAddress(L3AddressResolver().resolve(destinationAddress));
        packet->addTag<PacketProtocolTag>()->setProtocol(&Protocol::ipv4);
        ipv4Socket.send(packet);
    }
    else if (protocol == &Protocol::udp) {
        packet->clearTags();
        clientSocket.send(packet);
    }
    else
        throw cRuntimeError("Unknown protocol: %s", protocol->getName());
}

socketDataArrived() [3/3]

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

overrideprotectedvirtual

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

Implements inet::UdpSocket::ICallback.

{
    auto packetProtocol = packet->getTag<TransportProtocolInd>()->getProtocol();
    if (protocol == packetProtocol) {
        packet->clearTags();
        tunSocket.send(packet);
    }
    else
        throw cRuntimeError("Unknown protocol: %s", packetProtocol->getName());
}

socketErrorArrived()

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

overrideprotectedvirtual

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

Implements inet::UdpSocket::ICallback.

{
    delete indication;
}

Member Data Documentation

clientSocket

UdpSocket inet::TunnelApp::clientSocket

protected

Referenced by handleCrashOperation(), handleMessageWhenUp(), handleStopOperation(), initialize(), and socketDataArrived().

destinationAddress

const char* inet::TunnelApp::destinationAddress = nullptr

protected

Referenced by initialize(), and socketDataArrived().

destinationPort

int inet::TunnelApp::destinationPort = -1

protected

Referenced by initialize().

interface

const char* inet::TunnelApp::interface = nullptr

protected

Referenced by initialize().

ipv4Socket

Ipv4Socket inet::TunnelApp::ipv4Socket

protected

Referenced by handleCrashOperation(), handleMessageWhenUp(), handleStopOperation(), initialize(), and socketDataArrived().

localPort

int inet::TunnelApp::localPort = -1

protected

Referenced by initialize().

protocol

const Protocol* inet::TunnelApp::protocol = nullptr

protected

Referenced by initialize(), and socketDataArrived().

serverSocket

UdpSocket inet::TunnelApp::serverSocket

protected

Referenced by handleCrashOperation(), handleMessageWhenUp(), handleStopOperation(), and initialize().

socketMap

SocketMap inet::TunnelApp::socketMap

protected

Referenced by handleCrashOperation(), handleMessageWhenUp(), handleStopOperation(), and initialize().

tunSocket

TunSocket inet::TunnelApp::tunSocket

protected

Referenced by initialize(), and socketDataArrived().

---

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

• TunnelApp.h
• TunnelApp.cc