#include <MacRelayUnitBase.h>

Inheritance diagram for inet::MacRelayUnitBase:

Protected Member Functions
virtual void	initialize (int stage) override

virtual void	finish () override

virtual void	updateDisplayString () const

virtual const char *	resolveDirective (char directive) const override

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 void	updatePeerAddress (NetworkInterface *incomingInterface, MacAddress sourceAddress, unsigned int vlanId)

virtual void	handleStartOperation (LifecycleOperation *operation) override

virtual void	handleStopOperation (LifecycleOperation *operation) override

virtual void	handleCrashOperation (LifecycleOperation *operation) override

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

Protected Member Functions inherited from inet::LayeredProtocolBase
virtual void	handleMessageWhenUp (cMessage *message) override

virtual void	handleSelfMessage (cMessage *message)

virtual void	handleUpperMessage (cMessage *message)

virtual void	handleLowerMessage (cMessage *message)

virtual void	handleUpperCommand (cMessage *message)

virtual void	handleLowerCommand (cMessage *message)

virtual void	handleUpperPacket (Packet *packet)

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

ModuleRefByPar< IMacForwardingTable >	macForwardingTable

long	numProcessedFrames = 0

long	numDroppedFrames = 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::OperationalMixin< cSimpleModule >
virtual	~OperationalMixin ()
	}@ More...

Public Member Functions inherited from inet::ILifecycle
virtual	~ILifecycle ()

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

Member Function Documentation

◆ broadcastPacket()

void inet::MacRelayUnitBase::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 inet::MacRelayUnit::handleLowerPacket(), inet::Ieee8021dRelay::handleLowerPacket(), and inet::Ieee8021dRelay::handleUpperPacket().

◆ finish()

void inet::MacRelayUnitBase::finish ( )

overrideprotectedvirtual

Reimplemented in inet::Ieee8021dRelay.

 {
     recordScalar("processed frames", numProcessedFrames);
     recordScalar("discarded frames", numDroppedFrames);
 }

Referenced by inet::Ieee8021dRelay::finish().

◆ handleCrashOperation()

virtual void inet::MacRelayUnitBase::handleCrashOperation ( LifecycleOperation * operation )

inlineoverrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

Reimplemented in inet::Ieee8021dRelay.

44 {}

◆ handleStartOperation()

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

inlineoverrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

Reimplemented in inet::Ieee8021dRelay.

42 {}

◆ handleStopOperation()

virtual void inet::MacRelayUnitBase::handleStopOperation ( LifecycleOperation * operation )

inlineoverrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

Reimplemented in inet::Ieee8021dRelay.

43 {}

◆ initialize()

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

overrideprotectedvirtual

Reimplemented from inet::OperationalMixin< cSimpleModule >.

Reimplemented in inet::Ieee8021dRelay.

 {
     LayeredProtocolBase::initialize(stage);
     if (stage == INITSTAGE_LOCAL) {
         macForwardingTable.reference(this, "macTableModule", true);
         interfaceTable.reference(this, "interfaceTableModule", true);
         numProcessedFrames = numDroppedFrames = 0;
         WATCH(numProcessedFrames);
         WATCH(numDroppedFrames);
     }
     else if (stage == INITSTAGE_NETWORK_LAYER) {
         registerAnyService(gate("upperLayerIn"), gate("upperLayerOut"));
         registerAnyProtocol(gate("lowerLayerOut"), gate("lowerLayerIn"));
     }
 }

Referenced by inet::Ieee8021dRelay::initialize().

◆ isForwardingInterface()

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

inlineprotectedvirtual

Reimplemented in inet::Ieee8021dRelay.

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

Referenced by broadcastPacket(), and inet::Ieee8021dRelay::isForwardingInterface().

◆ isInitializeStage()

virtual bool inet::MacRelayUnitBase::isInitializeStage ( int stage ) const

inlineoverrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

48 { return stage == INITSTAGE_LINK_LAYER; }

◆ isLowerMessage()

virtual bool inet::MacRelayUnitBase::isLowerMessage ( cMessage * message ) const

inlineoverrideprotectedvirtual

Implements inet::LayeredProtocolBase.

46 { return message->arrivedOn("lowerLayerIn"); }

◆ isModuleStartStage()

virtual bool inet::MacRelayUnitBase::isModuleStartStage ( int stage ) const

inlineoverrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

49 { return stage == ModuleStartOperation::STAGE_LINK_LAYER; }

◆ isModuleStopStage()

virtual bool inet::MacRelayUnitBase::isModuleStopStage ( int stage ) const

inlineoverrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

50 { return stage == ModuleStopOperation::STAGE_LINK_LAYER; }

◆ isUpperMessage()

virtual bool inet::MacRelayUnitBase::isUpperMessage ( cMessage * message ) const

inlineoverrideprotectedvirtual

Implements inet::LayeredProtocolBase.

45 { return message->arrivedOn("upperLayerIn"); }

◆ resolveDirective()

const char * inet::MacRelayUnitBase::resolveDirective ( char directive ) const

overrideprotectedvirtual

Implements inet::StringFormat::IDirectiveResolver.

 {
     static std::string result;
     switch (directive) {
     case 'p':
         result = std::to_string(numProcessedFrames);
         break;
     case 'd':
         result = std::to_string(numDroppedFrames);
         break;
         default:
             throw cRuntimeError("Unknown directive: %c", directive);
     }
     return result.c_str();
 }

◆ sendPacket()

void inet::MacRelayUnitBase::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)
         packet->addTagIfAbsent<DispatchProtocolReq>()->setProtocol(protocol);
     else
         packet->removeTagIfPresent<DispatchProtocolReq>();
     emit(packetSentToLowerSignal, packet);
     send(packet, "lowerLayerOut");
 }

Referenced by broadcastPacket(), inet::MacRelayUnit::handleLowerPacket(), inet::Ieee8021dRelay::handleLowerPacket(), and inet::Ieee8021dRelay::handleUpperPacket().

◆ updateDisplayString()

void inet::MacRelayUnitBase::updateDisplayString ( ) const

protectedvirtual

 {
     if (getEnvir()->isGUI()) {
         auto text = StringFormat::formatString(par("displayStringTextFormat"), this);
         getDisplayString().setTagArg("t", 0, text);
     }
 }

Referenced by inet::MacRelayUnit::handleLowerPacket(), and inet::Ieee8021dRelay::handleLowerPacket().

◆ updatePeerAddress()

void inet::MacRelayUnitBase::updatePeerAddress	(	NetworkInterface *	incomingInterface,
		MacAddress	sourceAddress,
		unsigned int	vlanId
	)

protectedvirtual

Reimplemented in inet::Ieee8021dRelay.

 {
     if (!sourceAddress.isMulticast()) {
         EV_INFO << "Learning peer address" << EV_FIELD(sourceAddress) << EV_FIELD(incomingInterface) << EV_ENDL;
         macForwardingTable->learnUnicastAddressForwardingInterface(incomingInterface->getInterfaceId(), sourceAddress, vlanId);
     }
 }

Referenced by inet::MacRelayUnit::handleLowerPacket(), and inet::Ieee8021dRelay::updatePeerAddress().

Member Data Documentation

◆ interfaceTable

ModuleRefByPar<IInterfaceTable> inet::MacRelayUnitBase::interfaceTable

protected

Referenced by broadcastPacket(), inet::Ieee8021dRelay::chooseBridgeInterface(), inet::MacRelayUnit::handleLowerPacket(), inet::Ieee8021dRelay::handleLowerPacket(), inet::Ieee8021dRelay::handleUpperPacket(), and initialize().

◆ macForwardingTable

ModuleRefByPar<IMacForwardingTable> inet::MacRelayUnitBase::macForwardingTable

protected

Referenced by inet::MacRelayUnit::handleLowerPacket(), inet::Ieee8021dRelay::handleLowerPacket(), inet::Ieee8021dRelay::handleUpperPacket(), initialize(), and updatePeerAddress().

◆ numDroppedFrames

long inet::MacRelayUnitBase::numDroppedFrames = 0

protected

Referenced by finish(), inet::Ieee8021dRelay::finish(), inet::MacRelayUnit::handleLowerPacket(), inet::Ieee8021dRelay::handleLowerPacket(), initialize(), and resolveDirective().

◆ numProcessedFrames

long inet::MacRelayUnitBase::numProcessedFrames = 0

protected

Referenced by finish(), inet::MacRelayUnit::handleLowerPacket(), initialize(), and resolveDirective().

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

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ broadcastPacket()

◆ finish()

◆ handleCrashOperation()

◆ handleStartOperation()

◆ handleStopOperation()

◆ initialize()

◆ isForwardingInterface()

◆ isInitializeStage()

◆ isLowerMessage()

◆ isModuleStartStage()

◆ isModuleStopStage()

◆ isUpperMessage()

◆ resolveDirective()

◆ sendPacket()

◆ updateDisplayString()

◆ updatePeerAddress()

Member Data Documentation

◆ interfaceTable

◆ macForwardingTable

◆ numDroppedFrames

◆ numProcessedFrames