#include <RelayInterfaceSelector.h>

Inheritance diagram for inet::RelayInterfaceSelector:

Protected Member Functions
virtual void	initialize (int stage) override

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

virtual bool	isForwardingInterface (NetworkInterface *networkInterface) const

virtual void	broadcastPacket (Packet packet, const MacAddress &destinationAddress, NetworkInterface incomingInterface)

virtual void	sendPacket (Packet packet, const MacAddress &destinationAddress, NetworkInterface outgoingInterface)

virtual bool	isForwardingService (const Protocol &protocol, cGate *gate, ServicePrimitive servicePrimitive) const override

virtual bool	isForwardingServiceGroup (const ProtocolGroup &protocolGroup, cGate *gate, ServicePrimitive servicePrimitive) const override

virtual bool	isForwardingAnyService (cGate *gate, ServicePrimitive servicePrimitive) const override

virtual bool	isForwardingProtocol (const Protocol &protocol, cGate *gate, ServicePrimitive servicePrimitive) const override

virtual bool	isForwardingProtocolGroup (const ProtocolGroup &protocolGroup, cGate *gate, ServicePrimitive servicePrimitive) const override

virtual bool	isForwardingAnyProtocol (cGate *gate, ServicePrimitive servicePrimitive) const override

virtual cGate *	getRegistrationForwardingGate (cGate *gate) override

Protected Member Functions inherited from inet::queueing::PacketPusherBase
virtual void	handleMessage (cMessage *message) override

Protected Member Functions inherited from inet::queueing::PacketProcessorBase
virtual int	numInitStages () const override

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
ModuleRefByPar< IInterfaceTable >	interfaceTable

ModuleRefByPar< IMacForwardingTable >	macForwardingTable

long	numProcessedFrames = 0

long	numDroppedFrames = 0

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

IActivePacketSource *	producer = nullptr

cGate *	outputGate = nullptr

IPassivePacketSink *	consumer = nullptr

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

int	numProcessedPackets = -1

b	processedTotalLength = b(-1)

Additional Inherited Members
Public Member Functions inherited from inet::queueing::PacketPusherBase
virtual IPassivePacketSink *	getConsumer (cGate *gate) override
	Returns the passive packet sink where packets are pushed or nullptr if the connected module doesn't implement the interface. More...

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...

virtual void	handleCanPushPacketChanged (cGate *gate) override
	Notifies about a change in the possibility of pushing some packet into the passive packet sink at the given gate. More...

virtual void	handlePushPacketProcessed (Packet packet, cGate gate, bool successful) override
	Notifies about the completion of the packet processing for a packet that was pushed earlier independently whether the packet is passed or streamed. 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 ()

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

Public Member Functions inherited from inet::TransparentProtocolRegistrationListener
virtual void	mapRegistrationForwardingGates (cGate gate, std::function< void(cGate )> f)

virtual bool	isForwardingProtocol (cGate *gate, ServicePrimitive servicePrimitive) const

virtual bool	isForwardingService (cGate *gate, ServicePrimitive servicePrimitive) const

virtual void	handleRegisterService (const Protocol &protocol, cGate *gate, ServicePrimitive servicePrimitive) override

virtual void	handleRegisterProtocol (const Protocol &protocol, cGate *gate, ServicePrimitive servicePrimitive) override

virtual void	handleRegisterServiceGroup (const ProtocolGroup &protocolGroup, cGate *gate, ServicePrimitive servicePrimitive) override

virtual void	handleRegisterProtocolGroup (const ProtocolGroup &protocolGroup, cGate *gate, ServicePrimitive servicePrimitive) override

virtual void	handleRegisterAnyService (cGate *gate, ServicePrimitive servicePrimitive) override

virtual void	handleRegisterAnyProtocol (cGate *gate, ServicePrimitive servicePrimitive) override

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

Member Function Documentation

◆ broadcastPacket()

void inet::RelayInterfaceSelector::broadcastPacket	(	Packet *	packet,
		const MacAddress &	destinationAddress,
		NetworkInterface *	incomingInterface
	)

protectedvirtual

 {
     if (incomingInterface == nullptr)
         EV_INFO << "Broadcasting packet to all interfaces" << EV_FIELD(destinationAddress) << EV_FIELD(outgoingPacket) << EV_ENDL;
     else
         EV_INFO << "Broadcasting packet to all interfaces except incoming interface" << EV_FIELD(destinationAddress) << EV_FIELD(incomingInterface) << EV_FIELD(outgoingPacket) << EV_ENDL;
     for (int i = 0; i < interfaceTable->getNumInterfaces(); i++) {
         auto outgoingInterface = interfaceTable->getInterface(i);
         if (incomingInterface != outgoingInterface && isForwardingInterface(outgoingInterface))
             sendPacket(outgoingPacket->dup(), destinationAddress, outgoingInterface);
     }
     delete outgoingPacket;
 }

Referenced by pushPacket().

◆ getRegistrationForwardingGate()

cGate * inet::RelayInterfaceSelector::getRegistrationForwardingGate ( cGate * gate )

overrideprotectedvirtual

Reimplemented from inet::TransparentProtocolRegistrationListener.

 {
     if (gate == outputGate)
         return inputGate;
     else if (gate == inputGate)
         return outputGate;
     else
         throw cRuntimeError("Unknown gate");
 }

◆ initialize()

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

overrideprotectedvirtual

Reimplemented from inet::queueing::PacketPusherBase.

 {
     PacketPusherBase::initialize(stage);
     if (stage == INITSTAGE_LOCAL) {
         macForwardingTable.reference(this, "macTableModule", true);
         interfaceTable.reference(this, "interfaceTableModule", true);
         WATCH(numProcessedFrames);
         WATCH(numDroppedFrames);
     }
 }

◆ isForwardingAnyProtocol()

virtual bool inet::RelayInterfaceSelector::isForwardingAnyProtocol	(	cGate *	gate,
		ServicePrimitive	servicePrimitive
	)		const

inlineoverrideprotectedvirtual

Reimplemented from inet::TransparentProtocolRegistrationListener.

45 { return false; }

◆ isForwardingAnyService()

virtual bool inet::RelayInterfaceSelector::isForwardingAnyService	(	cGate *	gate,
		ServicePrimitive	servicePrimitive
	)		const

inlineoverrideprotectedvirtual

Reimplemented from inet::TransparentProtocolRegistrationListener.

41 { return servicePrimitive == SP_REQUEST; }

◆ isForwardingInterface()

virtual bool inet::RelayInterfaceSelector::isForwardingInterface ( NetworkInterface * networkInterface ) const

inlineprotectedvirtual

35 { return !networkInterface->isLoopback() && networkInterface->isBroadcast(); }

Referenced by broadcastPacket().

◆ isForwardingProtocol()

virtual bool inet::RelayInterfaceSelector::isForwardingProtocol	(	const Protocol &	protocol,
		cGate *	gate,
		ServicePrimitive	servicePrimitive
	)		const

inlineoverrideprotectedvirtual

Reimplemented from inet::TransparentProtocolRegistrationListener.

43 { return false; }

◆ isForwardingProtocolGroup()

virtual bool inet::RelayInterfaceSelector::isForwardingProtocolGroup	(	const ProtocolGroup &	protocolGroup,
		cGate *	gate,
		ServicePrimitive	servicePrimitive
	)		const

inlineoverrideprotectedvirtual

Reimplemented from inet::TransparentProtocolRegistrationListener.

44 { return false; }

◆ isForwardingService()

virtual bool inet::RelayInterfaceSelector::isForwardingService	(	const Protocol &	protocol,
		cGate *	gate,
		ServicePrimitive	servicePrimitive
	)		const

inlineoverrideprotectedvirtual

Reimplemented from inet::TransparentProtocolRegistrationListener.

39 { return servicePrimitive == SP_REQUEST; }

◆ isForwardingServiceGroup()

virtual bool inet::RelayInterfaceSelector::isForwardingServiceGroup	(	const ProtocolGroup &	protocolGroup,
		cGate *	gate,
		ServicePrimitive	servicePrimitive
	)		const

inlineoverrideprotectedvirtual

Reimplemented from inet::TransparentProtocolRegistrationListener.

40 { return servicePrimitive == SP_REQUEST; }

◆ pushPacket()

void inet::RelayInterfaceSelector::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.

Reimplemented from inet::queueing::PacketPusherBase.

 {
     Enter_Method("pushPacket");
     take(packet);
     auto interfaceReq = packet->findTag<InterfaceReq>();
     auto macAddressReq = packet->getTag<MacAddressReq>();
     auto destinationAddress = macAddressReq->getDestAddress();
     if (interfaceReq != nullptr) {
         auto networkInterface = interfaceTable->getInterfaceById(interfaceReq->getInterfaceId());
         sendPacket(packet, destinationAddress, networkInterface);
     }
     else {
         auto interfaceInd = packet->findTag<InterfaceInd>();
         auto incomingInterface = interfaceInd != nullptr ? interfaceTable->getInterfaceById(interfaceInd->getInterfaceId()) : nullptr;
         auto vlanReq = packet->findTag<VlanReq>();
         int vlanId = vlanReq != nullptr ? vlanReq->getVlanId() : 0;
         if (destinationAddress.isBroadcast())
             broadcastPacket(packet, destinationAddress, incomingInterface);
         else if (destinationAddress.isMulticast()) {
             auto outgoingInterfaceIds = macForwardingTable->getMulticastAddressForwardingInterfaces(destinationAddress, vlanId);
             if (outgoingInterfaceIds.size() == 0)
                 broadcastPacket(packet, destinationAddress, incomingInterface);
             else {
                 for (auto outgoingInterfaceId : outgoingInterfaceIds) {
                     if (interfaceInd != nullptr && outgoingInterfaceId == interfaceInd->getInterfaceId())
                         EV_WARN << "Ignoring outgoing interface because it is the same as incoming interface" << EV_FIELD(destinationAddress) << EV_FIELD(incomingInterface) << EV_FIELD(packet) << EV_ENDL;
                     else {
                         auto outgoingInterface = interfaceTable->getInterfaceById(outgoingInterfaceId);
                         sendPacket(packet->dup(), destinationAddress, outgoingInterface);
                     }
                 }
                 delete packet;
             }
         }
         else {
             // Find output interface of destination address and send packet to output interface
             // if not found then broadcasts to all other interfaces instead
             int outgoingInterfaceId = macForwardingTable->getUnicastAddressForwardingInterface(destinationAddress, vlanId);
             // should not send out the same packet on the same interface
             // (although wireless interfaces are ok to receive the same message)
             if (interfaceInd != nullptr && outgoingInterfaceId == interfaceInd->getInterfaceId()) {
                 EV_WARN << "Discarding packet because outgoing interface is the same as incoming interface" << EV_FIELD(destinationAddress) << EV_FIELD(incomingInterface) << EV_FIELD(packet) << EV_ENDL;
                 numDroppedFrames++;
                 PacketDropDetails details;
                 details.setReason(NO_INTERFACE_FOUND);
                 emit(packetDroppedSignal, packet, &details);
                 delete packet;
             }
             else if (outgoingInterfaceId != -1) {
                 auto outgoingInterface = interfaceTable->getInterfaceById(outgoingInterfaceId);
                 sendPacket(packet, destinationAddress, outgoingInterface);
             }
             else
                 broadcastPacket(packet, destinationAddress, incomingInterface);
         }
     }
     numProcessedFrames++;
     updateDisplayString();
 }

◆ sendPacket()

void inet::RelayInterfaceSelector::sendPacket	(	Packet *	packet,
		const MacAddress &	destinationAddress,
		NetworkInterface *	outgoingInterface
	)

protectedvirtual

 {
     EV_INFO << "Sending packet to peer" << EV_FIELD(destinationAddress) << EV_FIELD(outgoingInterface) << EV_FIELD(packet) << EV_ENDL;
     packet->addTagIfAbsent<DirectionTag>()->setDirection(DIRECTION_OUTBOUND);
     packet->addTagIfAbsent<InterfaceReq>()->setInterfaceId(outgoingInterface->getInterfaceId());
     auto protocol = outgoingInterface->getProtocol();
     if (protocol != nullptr) {
         if (auto dispatchProtocolReq = packet->findTag<DispatchProtocolReq>()) {
             auto encapsulationProtocolReq = packet->addTagIfAbsent<EncapsulationProtocolReq>();
             encapsulationProtocolReq->appendProtocol(protocol);
         }
         else
             packet->addTag<DispatchProtocolReq>()->setProtocol(protocol);
     }
     pushOrSendPacket(packet, outputGate, consumer);
 }

Referenced by broadcastPacket(), and pushPacket().

Member Data Documentation

◆ interfaceTable

ModuleRefByPar<IInterfaceTable> inet::RelayInterfaceSelector::interfaceTable

protected

Referenced by broadcastPacket(), initialize(), and pushPacket().

◆ macForwardingTable

ModuleRefByPar<IMacForwardingTable> inet::RelayInterfaceSelector::macForwardingTable

protected

Referenced by initialize(), and pushPacket().

◆ numDroppedFrames

long inet::RelayInterfaceSelector::numDroppedFrames = 0

protected

Referenced by initialize(), and pushPacket().

◆ numProcessedFrames

long inet::RelayInterfaceSelector::numProcessedFrames = 0

protected

Referenced by initialize(), and pushPacket().

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

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ broadcastPacket()

◆ getRegistrationForwardingGate()

◆ initialize()

◆ isForwardingAnyProtocol()

◆ isForwardingAnyService()

◆ isForwardingInterface()

◆ isForwardingProtocol()

◆ isForwardingProtocolGroup()

◆ isForwardingService()

◆ isForwardingServiceGroup()

◆ pushPacket()

◆ sendPacket()

Member Data Documentation

◆ interfaceTable

◆ macForwardingTable

◆ numDroppedFrames

◆ numProcessedFrames