inet::Tun Class Reference

#include <Tun.h>

Inheritance diagram for inet::Tun:

Public Member Functions
virtual int	numInitStages () const override
virtual void	initialize (int stage) override
virtual void	handleUpperMessage (cMessage *message) override
virtual void	handleUpperPacket (Packet *packet) override
virtual void	handleUpperCommand (cMessage *message) override
Public Member Functions inherited from inet::OperationalMixin< cSimpleModule >
virtual	~OperationalMixin ()
	}@ More...
Public Member Functions inherited from inet::ILifecycle
virtual	~ILifecycle ()

Protected Member Functions
virtual void	configureNetworkInterface () override
Protected Member Functions inherited from inet::MacProtocolBase
	MacProtocolBase ()
virtual	~MacProtocolBase ()
virtual void	registerInterface ()
virtual MacAddress	parseMacAddressParameter (const char *addrstr)
virtual void	deleteCurrentTxFrame ()
virtual void	dropCurrentTxFrame (PacketDropDetails &details)
virtual void	handleMessageWhenDown (cMessage *msg) override
virtual void	sendUp (cMessage *message)
virtual void	sendDown (cMessage *message)
virtual bool	isUpperMessage (cMessage *message) const override
virtual bool	isLowerMessage (cMessage *message) const override
virtual bool	isInitializeStage (int stage) const override
virtual bool	isModuleStartStage (int stage) const override
virtual bool	isModuleStopStage (int stage) const override
virtual void	flushQueue (PacketDropDetails &details)
	should clear queue and emit signal "packetDropped" with entire packets More...
virtual void	clearQueue ()
	should clear queue silently More...
virtual void	receiveSignal (cComponent *source, simsignal_t signalID, cObject *obj, cObject *details) override
virtual void	handleStartOperation (LifecycleOperation *operation) override
virtual void	handleStopOperation (LifecycleOperation *operation) override
virtual void	handleCrashOperation (LifecycleOperation *operation) override
queueing::IPacketQueue *	getQueue (cGate *gate) const
virtual bool	canDequeuePacket () const
virtual Packet *	dequeuePacket ()
Protected Member Functions inherited from inet::LayeredProtocolBase
virtual void	handleMessageWhenUp (cMessage *message) override
virtual void	handleSelfMessage (cMessage *message)
virtual void	handleLowerMessage (cMessage *message)
virtual void	handleLowerCommand (cMessage *message)
virtual void	handleLowerPacket (Packet *packet)
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 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< int >	socketIds
Protected Attributes inherited from inet::MacProtocolBase
int	upperLayerInGateId = -1
	Gate ids. More...
int	upperLayerOutGateId = -1
int	lowerLayerInGateId = -1
int	lowerLayerOutGateId = -1
opp_component_ptr< NetworkInterface >	networkInterface
opp_component_ptr< cModule >	hostModule
Packet *	currentTxFrame = nullptr
	Currently transmitted frame if any. More...
opp_component_ptr< queueing::IPacketQueue >	txQueue
	Messages received from upper layer and to be transmitted later. More...
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

Member Function Documentation

configureNetworkInterface()

void inet::Tun::configureNetworkInterface ( )

overrideprotectedvirtual

Implements inet::MacProtocolBase.

{
    networkInterface->setMtu(par("mtu"));
}

handleUpperCommand()

void inet::Tun::handleUpperCommand ( cMessage *  message )

overridevirtual

Reimplemented from inet::LayeredProtocolBase.

{
    cObject *controlInfo = message->getControlInfo();
    int socketId = check_and_cast<Request *>(message)->getTag<SocketReq>()->getSocketId();
    if (dynamic_cast<TunOpenCommand *>(controlInfo) != nullptr) {
        if (contains(socketIds, socketId))
            throw cRuntimeError("Socket is already open: %d", socketId);
        socketIds.push_back(socketId);
        delete message;
    }
    else if (dynamic_cast<TunCloseCommand *>(controlInfo) != nullptr) {
        auto it = find(socketIds, socketId);
        if (it != socketIds.end())
            socketIds.erase(it);
        delete message;
        auto indication = new Indication("closed", TUN_I_CLOSED);
        auto ctrl = new TunSocketClosedIndication();
        indication->setControlInfo(ctrl);
        indication->addTagIfAbsent<SocketInd>()->setSocketId(socketId);
        send(indication, "upperLayerOut");
    }
    else if (dynamic_cast<TunDestroyCommand *>(controlInfo) != nullptr) {
        auto it = find(socketIds, socketId);
        if (it != socketIds.end())
            socketIds.erase(it);
        delete message;
    }
    else
        throw cRuntimeError("Unknown command: %s", message->getName());
}

Referenced by handleUpperMessage().

handleUpperMessage()

void inet::Tun::handleUpperMessage ( cMessage *  message )

overridevirtual

Reimplemented from inet::LayeredProtocolBase.

{
    if (!message->isPacket())
        handleUpperCommand(message);
    else {
        handleUpperPacket(check_and_cast<Packet *>(message));
    }
}

handleUpperPacket()

void inet::Tun::handleUpperPacket ( Packet *  packet )

overridevirtual

Reimplemented from inet::LayeredProtocolBase.

{
    const auto& socketReq = packet->findTag<SocketReq>();
    // check if packet is from app by finding SocketReq with sockedId that is in socketIds
    auto sId = socketReq != nullptr ? socketReq->getSocketId() : -1;
    ASSERT(packet->getControlInfo() == nullptr);
    if (socketReq != nullptr && contains(socketIds, sId)) {
        // TODO should we determine the network protocol by looking at the packet?!
        packet->clearTags();
        packet->addTag<InterfaceInd>()->setInterfaceId(networkInterface->getInterfaceId());
        packet->addTag<DispatchProtocolReq>()->setProtocol(&Protocol::ipv4);
        packet->addTag<PacketProtocolTag>()->setProtocol(&Protocol::ipv4);
        emit(packetSentToUpperSignal, packet);
        send(packet, "upperLayerOut");
    }
    else {
        emit(packetReceivedFromUpperSignal, packet);
        for (int socketId : socketIds) {
            Packet *copy = packet->dup();
            copy->setKind(TUN_I_DATA);
            copy->clearTags();
            copy->addTag<SocketInd>()->setSocketId(socketId);
            copy->addTag<InterfaceInd>()->setInterfaceId(networkInterface->getInterfaceId());
            copy->addTag<PacketProtocolTag>()->setProtocol(packet->getTag<PacketProtocolTag>()->getProtocol());
            auto npTag = packet->getTag<NetworkProtocolInd>();
            auto newnpTag = copy->addTag<NetworkProtocolInd>();
            *newnpTag = *npTag;
            send(copy, "upperLayerOut");
        }
        delete packet;
    }
}

Referenced by handleUpperMessage().

initialize()

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

overridevirtual

Reimplemented from inet::MacProtocolBase.

{
    MacProtocolBase::initialize(stage);
    if (stage == INITSTAGE_LOCAL) {
        lowerLayerInGateId = findGate("phys$i");
        lowerLayerOutGateId = findGate("phys$o");
    }
}

numInitStages()

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

inlineoverridevirtual

{ return NUM_INIT_STAGES; }

Member Data Documentation

socketIds

std::vector<int> inet::Tun::socketIds

protected

Referenced by handleUpperCommand(), and handleUpperPacket().

---

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

• Tun.h
• Tun.cc