LocalTsnSwitch

Package: inet.showcases.tsn.combiningfeatures.frerandtas

LocalTsnSwitch

compound module

(no description)

macTable : like IMacForwardingTable IMacForwardingTable: Interface for MAC address tables, used by MAC relay units in Ethenet switches. Source: macTable: <default(hasMrp ? "MrpMacForwardingTable" : "MacForwardingTable")> like IMacForwardingTable { @display("p=100,100;is=s"); } interfaceTable : InterfaceTable Keeps the table of network interfaces. Source: interfaceTable: InterfaceTable { @display("p=100,200;is=s"); } l2NodeConfigurator : like IL2NodeConfigurator L2NodeConfigurator: Has one instance per network node, and it acts like a bridge between the node and the network's... IL2NodeConfigurator: Interface for all layer 2 node configurators. Source: l2NodeConfigurator: <default("L2NodeConfigurator")> like IL2NodeConfigurator if hasStp || hasMrp { @display("p=100,300;is=s"); } status : NodeStatus Keeps track of the status of the network node (up, down, etc.) for other modules, and also displays... Source: status: NodeStatus if hasStatus { @display("p=100,400;is=s"); } clock : like IClock IClock: Interface for clock models. Source: clock: <default(hasGptp ? "SettableClock" : "")> like IClock if typename != "" { @display("p=100,500;is=s"); } pcapRecorder[numPcapRecorders] : PcapRecorder Records PCAP traces of frames sent/received by other modules within the same host. Source: pcapRecorder[numPcapRecorders]: PcapRecorder { @display("p=100,600;is=s"); } measurer : like IMeasurer IMeasurer: Interface for all standalone measurement modules. Source: measurer: <default("")> like IMeasurer if typename != "" { @display("p=100,700;is=s"); } mrp : like IMrp Mrp: Implements the Media Redundancy Protocol (MRP) as specified in IEC 62439-2. IMrp: Interface for modules that implement the Media Redundancy Protocol (MRP), specified in IEC 62439-2. Source: mrp: <default("Mrp")> like IMrp if hasMrp { @display("p=500,50"); } stp : like ISpanningTree ISpanningTree: Module interface for Spanning Tree protocols Source: stp: <spanningTreeProtocol> like ISpanningTree if hasStp { @display("p=500,75"); } gptp : like IGptp Gptp: Implements the generalized Precision Time Protocol (gPTP) as defined in the IEEE 802.1AS-2020... IGptp: Interface for gPTP module. Source: gptp: <default("Gptp")> like IGptp if hasGptp { @display("p=700,75"); gptpNodeType = default("BRIDGE_NODE"); // @enum("gptpNodeType"): MASTER_NODE, BRIDGE_NODE, SLAVE_NODE } app[numApps] : like IApp IApp: Generic application interface. Source: app[numApps]: <> like IApp { parameters: @display("p=900,75,row,150"); } sc : MessageDispatcher Facilitates the interconnection of applications, protocols, and network interfaces, dispatching... Source: sc: MessageDispatcher { @display("p=800,150;b=1200,5"); } llc : like IIeee8022Llc Source: llc: <default(hasMrp ? "Ieee8022Llc" : "")> like IIeee8022Llc if typename != "" || hasMrp { @display("p=700,225"); } cb : MessageDispatcher Facilitates the interconnection of applications, protocols, and network interfaces, dispatching... Source: cb: MessageDispatcher { @display("p=800,300;b=1200,5"); } bridging : like IProtocolLayer IProtocolLayer: Interface for all protocol layer modules that connect to a higher and to a lower protocol layer,... Source: bridging: <default(hasMrp ? "MrpRelay" : firstAvailable("Ieee8021dRelay","MacRelayUnit"))> like IProtocolLayer { @display("p=800,375;is=m"); } bl : MessageDispatcher Facilitates the interconnection of applications, protocols, and network interfaces, dispatching... Source: bl: MessageDispatcher { @display("p=800,450;b=1200,5"); } ethernet : like IEthernetLayer EthernetEncapsulation: Performs Ethernet II or Ethernet with LLC/SNAP encapsulation/decapsulation. IEthernetLayer: Module interface for Ethernet protocol layer implementations. Source: ethernet: <default("EthernetEncapsulation")> like IEthernetLayer if typename != "" { @display("p=500,525"); } ieee8021q : like IIeee8021qLayer Source: ieee8021q: <default("")> like IIeee8021qLayer if typename != "" { @display("p=700,525"); } ieee8021r : like IIeee8021rLayer Source: ieee8021r: <default("")> like IIeee8021rLayer if typename != "" { @display("p=900,525"); } li : MessageDispatcher Facilitates the interconnection of applications, protocols, and network interfaces, dispatching... Source: li: MessageDispatcher { @display("p=800,600;b=1200,5"); } eth[sizeof(ethg)] : like IEthernetInterface IEthernetInterface: Interface for Ethernet network interfaces. Source: eth[sizeof(ethg)]: <default(hasCutthroughSwitching ? "EthernetCutthroughInterface" : "EthernetInterface")> like IEthernetInterface { @display("p=250,750,row,150;q=txQueue"); }

Inheritance diagram

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

Used in

Name Type Description
FrerAndTasShowcase network (no description)

Extends

Name Type Description
TsnSwitch compound module

An Ethernet switch with Time-Sensitive Networking (TSN) capabilities. It extends the standard EthernetSwitch with various TSN features defined in the IEEE 802.1 standards suite for deterministic, low-latency communication over Ethernet networks.

Parameters

Name Type Default value Description
recordPcap bool false
numPcapRecorders int recordPcap ? 1 : 0
numApps int 0
hasStatus bool false
hasStp bool false
hasMrp bool false
hasGptp bool hasTimeSynchronization
hasCutthroughSwitching bool false
fcsMode string "declared"
spanningTreeProtocol string "Stp"
numEthInterfaces int 0

Minimum number of ethernet interfaces
hasTimeSynchronization bool false

Enable IEEE 802.1 AS time synchronization
hasIngressTrafficFiltering bool false

Enable IEEE 802.1 Qci ingress per-stream filtering
hasEgressTrafficShaping bool false

Enable IEEE 802.1 egress traffic shaping (credit based shaping, time aware shaping, asynchronous shaping)
hasStreamRedundancy bool false

Enable IEEE 802.1 CB frame replication and elimination
hasIncomingStreams bool false

Enable IEEE 802.1 stream decoding
hasOutgoingStreams bool false

Enable IEEE 802.1 stream identification and stream encoding
hasFramePreemption bool false

Enable IEEE 802.1 Qbu frame preemption

Properties

Name Value Description
networkNode
labels node
display i=device/switch
defaultStatistic gateStateChanged:vector,eth[0].macLayer.queue.gate[0]

Gates

Name Direction Size Description
ethg [ ] inout numEthInterfaces

Unassigned submodule parameters

Name Type Default value Description
macTable.agingTime double
macTable.forwardingTableFile string
interfaceTable.displayStringTextFormat string ""

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
interfaceTable.displayAddresses bool false

Whether to display IP addresses on links
status.displayStringTextFormat string ""

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
status.initialStatus string "UP"

TODO @signal, @statistic
pcapRecorder.displayStringTextFormat string "rec: %n pks"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
pcapRecorder.verbose bool true

Whether to log packets on the module output
pcapRecorder.recordEmptyPackets bool true

Specifies if zero length packets are recorded or not
pcapRecorder.enableConvertingPackets bool true

Specifies if converting packets to link type is allowed or not
pcapRecorder.pcapFile string ""

The PCAP file to be written, suggested value: pcapFile = "${resultdir}/${configname}-#${runnumber}" + fullpath() + ".pcap"
pcapRecorder.fileFormat string "pcapng"
pcapRecorder.snaplen int 65535

Maximum number of bytes to record per packet
pcapRecorder.timePrecision int 6

Time precision in recorded file. pcap supports only 6 (usec) or 9 (nanosec), pcapng supports more values (see 'if_tsresol' option in pcapng file format).
pcapRecorder.dumpBadFrames bool true

Enable dump of frames with hasBitError
pcapRecorder.moduleNamePatterns string "wlan[*] eth[*] ppp[*]"

Space-separated list of sibling module names to listen on
pcapRecorder.sendingSignalNames string "transmissionEnded"

Space-separated list of outbound packet signals to subscribe to
pcapRecorder.receivingSignalNames string "receptionEnded"

Space-separated list of inbound packet signals to subscribe to
pcapRecorder.dumpProtocols string "ethernetmac ppp ieee80211mac"

Space-separated list of protocol names as defined in the Protocol class
pcapRecorder.packetFilter object "*"

Which packets are considered, matches all packets by default
pcapRecorder.helpers string ""

Usable PcapRecorder::IHelper helpers for accept packettype and store/convert packet as specified linktype currently available: "inet::AckingMacToEthernetPcapRecorderHelper"
pcapRecorder.alwaysFlush bool false

Flush the pcapFile after each write to ensure that all packets are captured in case of a crash
mrp.ccmInterval double
mrp.mrpRole string
mrp.timingProfile int
mrp.uuid0 int
mrp.uuid1 int
mrp.ringPort1 int
mrp.ringPort2 int
mrp.interconnectionLinkCheckAware bool
mrp.interconnectionRingCheckAware bool
mrp.nonblockingMrcSupported bool
mrp.reactOnLinkChange bool
mrp.visualize bool
stp.helloTime double
stp.forwardDelay double
stp.maxAge double
stp.bridgePriority int
stp.visualize bool
gptp.gptpNodeType string "BRIDGE_NODE"
sc.displayStringTextFormat string "processed %p pk (%l)"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
sc.interfaceTableModule string

Module path to the ~InterfaceTable module
sc.forwardServiceRegistration bool true
sc.forwardProtocolRegistration bool true
sc.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
sc.serviceMapping object {}

Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
sc.protocolMapping object {}

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
cb.displayStringTextFormat string "processed %p pk (%l)"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
cb.interfaceTableModule string

Module path to the ~InterfaceTable module
cb.forwardServiceRegistration bool true
cb.forwardProtocolRegistration bool true
cb.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
cb.serviceMapping object {}

Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
cb.protocolMapping object {}

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
bl.displayStringTextFormat string "processed %p pk (%l)"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
bl.interfaceTableModule string

Module path to the ~InterfaceTable module
bl.forwardServiceRegistration bool true
bl.forwardProtocolRegistration bool true
bl.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
bl.serviceMapping object {}

Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
bl.protocolMapping object {}

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
li.displayStringTextFormat string "processed %p pk (%l)"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
li.interfaceTableModule string

Module path to the ~InterfaceTable module
li.forwardServiceRegistration bool true
li.forwardProtocolRegistration bool true
li.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
li.serviceMapping object {}

Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
li.protocolMapping object {}

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
eth.bitrate double

Source code

module LocalTsnSwitch extends TsnSwitch
{
    @defaultStatistic("gateStateChanged:vector"; module="eth[0].macLayer.queue.gate[0]");
}
File: showcases/tsn/combiningfeatures/frerandtas/FrerAndTasShowcase.ned

This documentation is released under the Creative Commons license