#include <VirtualTunnel.h>

Inheritance diagram for inet::VirtualTunnel:

Public Member Functions
virtual	~VirtualTunnel ()

Public Member Functions inherited from inet::queueing::PassivePacketSinkBase
virtual bool	supportsPacketPushing (cGate *gate) const override
	Returns true if the processor supports pushing packets at the given gate. More...

virtual bool	supportsPacketPulling (cGate *gate) const override
	Returns true if the processor supports pulling packets at the given gate. More...

virtual bool	canPushSomePacket (cGate *gate) const override
	Returns false if the packet sink is full at the given gate and no more packets can be pushed into it without raising an error. More...

virtual bool	canPushPacket (Packet packet, cGate gate) const override
	Returns true if the given packet can be pushed at the given gate into the packet sink without raising an error. More...

virtual void	pushPacketStart (Packet packet, cGate gate, bps datarate) override
	Starts pushing the packet into the packet sink at the given gate. More...

virtual void	pushPacketEnd (Packet packet, cGate gate) override
	Ends pushing the packet into the packet sink at the given gate. More...

virtual void	pushPacketProgress (Packet packet, cGate gate, bps datarate, b position, b extraProcessableLength=b(0)) override
	Progresses pushing the packet into the packet sink at the given gate. More...

Public Member Functions inherited from inet::queueing::PacketProcessorBase
virtual bool	supportsPacketSending (cGate *gate) const override
	Returns true if the processor supports sending packets at the given gate. More...

virtual bool	supportsPacketPassing (cGate *gate) const override
	Returns true if the processor supports passing packets as a whole at the given gate. More...

virtual bool	supportsPacketStreaming (cGate *gate) const override
	Returns true if the processor supports streaming packets at the given gate. More...

virtual const char *	resolveDirective (char directive) const override

Public Member Functions inherited from inet::queueing::IPacketProcessor
virtual	~IPacketProcessor ()

Public Member Functions inherited from inet::queueing::IPassivePacketSink
virtual	~IPassivePacketSink ()

Protected Member Functions
virtual int	numInitStages () const override

virtual void	initialize (int stage) override

virtual void	handleMessage (cMessage *message) override

virtual void	pushPacket (Packet packet, cGate gate) override
	Pushes the packet into the packet sink at the given gate. More...

Protected Member Functions inherited from inet::queueing::PacketProcessorBase
virtual void	refreshDisplay () const override

virtual void	handlePacketProcessed (Packet *packet)

virtual void	checkPacketOperationSupport (cGate *gate) const

virtual void	checkPacketOperationSupport (cGate startGate, cGate endGate) const

virtual void	animate (Packet packet, cGate gate, const SendOptions &sendOptions, Action action) const

virtual void	animatePacket (Packet packet, cGate gate, Action action) const

virtual void	animatePacketStart (Packet packet, cGate gate, bps datarate, long transmissionId, Action action) const

virtual void	animatePacketStart (Packet packet, cGate gate, bps datarate, const SendOptions &sendOptions, Action action) const

virtual void	animatePacketEnd (Packet packet, cGate gate, long transmissionId, Action action) const

virtual void	animatePacketEnd (Packet packet, cGate gate, const SendOptions &sendOptions, Action action) const

virtual void	animatePacketProgress (Packet packet, cGate gate, bps datarate, b position, b extraProcessableLength, long transmissionId, Action action) const

virtual void	animatePacketProgress (Packet packet, cGate gate, bps datarate, b position, b extraProcessableLength, const SendOptions &sendOptions, Action action) const

virtual void	pushOrSendPacket (Packet packet, cGate gate, IPassivePacketSink *consumer)

virtual void	pushOrSendPacketStart (Packet packet, cGate gate, IPassivePacketSink *consumer, bps datarate, int transmissionId)

virtual void	pushOrSendPacketEnd (Packet packet, cGate gate, IPassivePacketSink *consumer, int transmissionId)

virtual void	pushOrSendPacketProgress (Packet packet, cGate gate, IPassivePacketSink *consumer, bps datarate, b position, b extraProcessableLength, int transmissionId)

virtual void	animatePush (Packet packet, cGate gate, const SendOptions &sendOptions) const

virtual void	animatePushPacket (Packet packet, cGate gate) const

virtual void	animatePushPacketStart (Packet packet, cGate gate, bps datarate, long transmissionId) const

virtual void	animatePushPacketStart (Packet packet, cGate gate, bps datarate, const SendOptions &sendOptions) const

virtual void	animatePushPacketEnd (Packet packet, cGate gate, long transmissionId) const

virtual void	animatePushPacketEnd (Packet packet, cGate gate, const SendOptions &sendOptions) const

virtual void	animatePushPacketProgress (Packet packet, cGate gate, bps datarate, b position, b extraProcessableLength, long transmissionId) const

virtual void	animatePushPacketProgress (Packet packet, cGate gate, bps datarate, b position, b extraProcessableLength, const SendOptions &sendOptions) const

virtual void	animatePull (Packet packet, cGate gate, const SendOptions &sendOptions) const

virtual void	animatePullPacket (Packet packet, cGate gate) const

virtual void	animatePullPacketStart (Packet packet, cGate gate, bps datarate, long transmissionId) const

virtual void	animatePullPacketStart (Packet packet, cGate gate, bps datarate, const SendOptions &sendOptions) const

virtual void	animatePullPacketEnd (Packet packet, cGate gate, long transmissionId) const

virtual void	animatePullPacketEnd (Packet packet, cGate gate, const SendOptions &sendOptions) const

virtual void	animatePullPacketProgress (Packet packet, cGate gate, bps datarate, b position, b extraProcessableLength, long transmissionId) const

virtual void	animatePullPacketProgress (Packet packet, cGate gate, bps datarate, b position, b extraProcessableLength, const SendOptions &sendOptions) const

virtual void	dropPacket (Packet *packet, PacketDropReason reason, int limit=-1)

virtual void	updateDisplayString () const

Protected Attributes
NetworkInterface *	realNetworkInterface = nullptr

NetworkInterface *	networkInterface = nullptr

const Protocol *	protocol = nullptr

int	vlanId = -1

ISocket *	socket = nullptr

Protected Attributes inherited from inet::queueing::PassivePacketSinkBase
cGate *	inputGate = nullptr

IActivePacketSource *	producer = nullptr

Protected Attributes inherited from inet::queueing::PacketProcessorBase
const char *	displayStringTextFormat = nullptr

int	numProcessedPackets = -1

b	processedTotalLength = b(-1)

Additional Inherited Members
Protected Types inherited from inet::queueing::PacketProcessorBase
enum	Action { PUSH, PULL }

Constructor & Destructor Documentation

◆ ~VirtualTunnel()

virtual inet::VirtualTunnel::~VirtualTunnel ( )

inlinevirtual

63 { delete socket; }

Member Function Documentation

◆ handleMessage()

void inet::VirtualTunnel::handleMessage ( cMessage * message )

overrideprotectedvirtual

Reimplemented from inet::queueing::PassivePacketSinkBase.

 {
     if (socket->belongsToSocket(message))
         socket->processMessage(message);
     else {
         auto packet = check_and_cast<Packet *>(message);
         if (vlanId != -1)
             packet->addTagIfAbsent<VlanReq>()->setVlanId(vlanId);
         packet->addTagIfAbsent<MacAddressReq>()->setSrcAddress(networkInterface->getMacAddress());
         socket->send(packet);
     }
 }

Referenced by pushPacket().

◆ initialize()

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

overrideprotectedvirtual

Reimplemented from inet::queueing::PassivePacketSinkBase.

 {
     if (stage == INITSTAGE_LOCAL) {
         vlanId = par("vlanId");
         networkInterface = getContainingNicModule(this);
         const char *protocolAsString = par("protocol");
         if (*protocolAsString != '\0')
             protocol = Protocol::findProtocol(protocolAsString);
     }
     else if (stage == INITSTAGE_NETWORK_INTERFACE_CONFIGURATION) {
         auto interfaceTable = getModuleFromPar<IInterfaceTable>(par("interfaceTableModule"), this);
         realNetworkInterface = CHK(interfaceTable->findInterfaceByName(par("realInterface")));
         const char *addressString = par("address");
         MacAddress address;
         if (!strcmp(addressString, "auto"))
             address = MacAddress::generateAutoAddress();
         else if (!strcmp(addressString, "copy"))
             address = realNetworkInterface->getMacAddress();
         else
             address = MacAddress(addressString);
         networkInterface->setMacAddress(address);
         networkInterface->setInterfaceToken(address.formInterfaceIdentifier());
         networkInterface->setBroadcast(realNetworkInterface->isBroadcast());
         networkInterface->setMulticast(realNetworkInterface->isMulticast());
         networkInterface->setPointToPoint(realNetworkInterface->isPointToPoint());
     }
     else if (stage == INITSTAGE_LINK_LAYER) {
         // KLUDGE depends on other interface
         if (!strcmp(par("address"), "copy"))
             networkInterface->setMacAddress(realNetworkInterface->getMacAddress());
         if (false) ;
 #ifdef INET_WITH_ETHERNET
         else if (protocol == &Protocol::ethernetMac) {
             auto ethernetSocket = new EthernetSocket();
             ethernetSocket->setCallback(this);
             ethernetSocket->setOutputGate(gate("upperLayerOut"));
             ethernetSocket->setNetworkInterface(realNetworkInterface);
             ethernetSocket->bind(networkInterface->getMacAddress(), MacAddress(), nullptr, par("steal"));
             socket = ethernetSocket;
         }
 #endif
 #ifdef INET_WITH_IEEE8021Q
         else if (protocol == &Protocol::ieee8021qCTag || protocol == &Protocol::ieee8021qSTag) {
             auto ieee8021qSocket = new Ieee8021qSocket();
             ieee8021qSocket->setCallback(this);
             ieee8021qSocket->setOutputGate(gate("upperLayerOut"));
             ieee8021qSocket->setNetworkInterface(realNetworkInterface);
             ieee8021qSocket->setProtocol(protocol);
             ieee8021qSocket->bind(nullptr, vlanId, par("steal"));
             socket = ieee8021qSocket;
         }
 #endif
         else
             throw cRuntimeError("Unknown protocol");
     }
 }

◆ numInitStages()

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

inlineoverrideprotectedvirtual

Reimplemented from inet::queueing::PacketProcessorBase.

45 { return NUM_INIT_STAGES; }

◆ pushPacket()

void inet::VirtualTunnel::pushPacket	(	Packet *	packet,
		cGate *	gate
	)

overrideprotectedvirtual

Pushes the packet into the packet sink at the given gate.

This operation pushes the packet as a whole. The onwership of the packet is transferred to the sink.

This method is called, for example, when a packet source module pushes a packet into a queue module.

The sink must not be full at the gate. The packet must not be nullptr. The gate must be a valid gate of this module and it must support pushing and passing packets.

Implements inet::queueing::IPassivePacketSink.

 {
     Enter_Method("pushPacket");
     take(packet);
     handleMessage(packet);
 }

Member Data Documentation

◆ networkInterface

NetworkInterface* inet::VirtualTunnel::networkInterface = nullptr

protected

Referenced by handleMessage(), and initialize().

◆ protocol

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

protected

Referenced by initialize().

◆ realNetworkInterface

NetworkInterface* inet::VirtualTunnel::realNetworkInterface = nullptr

protected

Referenced by initialize().

◆ socket

ISocket* inet::VirtualTunnel::socket = nullptr

protected

Referenced by handleMessage(), initialize(), and ~VirtualTunnel().

◆ vlanId

int inet::VirtualTunnel::vlanId = -1

protected

Referenced by handleMessage(), and initialize().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ ~VirtualTunnel()

Member Function Documentation

◆ handleMessage()

◆ initialize()

◆ numInitStages()

◆ pushPacket()

Member Data Documentation

◆ networkInterface

◆ protocol

◆ realNetworkInterface

◆ socket

◆ vlanId