VlanReqMapper

simple module

This module updates the VlanReq tag on packets.

Inheritance diagram

The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.

Extends

Name	Type	Description
PacketFlowBase	simple module	This is a base module for various packet flow modules. A packet flow module passes or streams all pushed or pulled packets after processing them from its input to its output.

Parameters

Name	Type	Default value	Description
displayStringTextFormat	string	"processed %p pk (%l)"	determines the text that is written on top of the submodule
interfaceTableModule	string
protocol	string	"ieee8021qctag"
mappedVlanIds	object	{}	maps network interface name to another map which maps accepted VLAN ids to replacement VLAN ids, '*' as interface name matches all interfaces, -1 VLAN id matches if no tag is present

Properties

Name	Value	Description
display	i=block/switch
class	VlanReqMapper

Gates

Name	Direction	Size	Description
in	input
out	output

Signals

Name	Type	Unit
packetPushedIn	inet::Packet
packetPulledIn	inet::Packet
packetPushedOut	inet::Packet
packetPulledOut	inet::Packet

Statistics

Name	Title	Source	Record	Unit	Interpolation Mode
flowIncomingDataRate	flow specific incoming data rate	throughput(demuxFlow(merge(packetPushedIn, packetPulledIn)))	vector	bps	linear
outgoingDataRate	outgoing data rate	throughput(merge(packetPushedOut, packetPulledOut))	vector	bps	linear
incomingDataRate	incoming data rate	throughput(merge(packetPushedIn, packetPulledIn))	vector	bps	linear
outgoingPacketLengths	outgoing packet lengths	packetLength(merge(packetPushedOut, packetPulledOut))	sum, histogram, vector	b	none
flowIncomingPacketLengths	flow specific incoming packet lengths	packetLength(demuxFlow(merge(packetPushedIn, packetPulledIn)))	sum, histogram, vector	b	none
flowOutgoingDataRate	flow specific outgoing data rate	throughput(demuxFlow(merge(packetPushedOut, packetPulledOut)))	vector	bps	linear
incomingPacketLengths	incoming packet lengths	packetLength(merge(packetPushedIn, packetPulledIn))	sum, histogram, vector	b	none
flowOutgoingPacketLengths	flow specific outgoing packet lengths	packetLength(demuxFlow(merge(packetPushedOut, packetPulledOut)))	sum, histogram, vector	b	none
incomingPackets	incoming packets	merge(packetPushedIn, packetPulledIn)	count	pk
outgoingPackets	outgoing packets	merge(packetPushedOut, packetPulledOut)	count	pk

Direct method calls (observed)

call to	function	info
MessageDispatcher	inet::MessageDispatcher::handleRegisterProtocol	handleRegisterProtocol
MessageDispatcher	inet::MessageDispatcher::handleRegisterService	handleRegisterService
VlanReqFilter	inet::VlanReqFilter::pushPacket	pushPacket
VlanReqMapper	inet::VlanReqMapper::pushPacket	pushPacket

Called methods (observed)

function	info	call from
inet::VlanReqMapper::pushPacket	pushPacket	RelayInterfaceSelector, VlanReqMapper

Incoming messages (observed)

gate	msg	kind	ctrl	srcModule	tags
in	Packet	0		Arp	DispatchProtocolReq, InterfaceReq, MacAddressReq, PacketProtocolTag
in	Packet	0		Ipv4	DispatchProtocolInd, DispatchProtocolReq, EcnInd, EncapsulationProtocolReq, InterfaceReq, MacAddressReq, NetworkProtocolInd, PacketProtocolTag, TransportProtocolInd

Pushed in messages (observed)

gate	msg	kind	ctrl	srcModule	tags
in	Packet	0		RelayInterfaceSelector	DirectionTag, DispatchProtocolReq, EncapsulationProtocolReq, InterfaceInd, InterfaceReq, MacAddressReq, PacketProtocolTag, DropEligibleReq?, UserPriorityReq?, VlanReq?

Push out messages (observed)

gate	msg	kind	ctrl	destModule	tags
out	Packet	0		VlanReqFilter	DispatchProtocolReq, EncapsulationProtocolReq, InterfaceReq, MacAddressReq, PacketProtocolTag, DirectionTag?, DispatchProtocolInd?, DropEligibleReq?, EcnInd?, InterfaceInd?, NetworkProtocolInd?, TransportProtocolInd?, UserPriorityReq?, VlanReq?

Shared Tagging operations (observed)

tagType	tagAction
DispatchProtocolReq	addTagIfAbsent
EncapsulationProtocolReq	addTagIfAbsent, findTagForUpdate
InterfaceReq	findTag
PcpReq	findTag
VlanReq	addTagIfAbsent, findTag, removeTagIfPresent

Region Tagging operations (observed)

tagType	tagAction
FlowTag	mapAllTags

Source code

//
// This module updates the VlanReq tag on packets.
//
simple VlanReqMapper extends PacketFlowBase like IPacketFlow
{
    parameters:
        string interfaceTableModule;
        string protocol = default("ieee8021qctag");
        object mappedVlanIds = default({}); // maps network interface name to another map which maps accepted VLAN ids to replacement VLAN ids, '*' as interface name matches all interfaces, -1 VLAN id matches if no tag is present
        @class(VlanReqMapper);
        @display("i=block/switch");
}

File: src/inet/linklayer/vlan/VlanReqMapper.ned