CutthroughSwitchingShowcase

Package: inet.showcases.tsn.cutthroughswitching

CutthroughSwitchingShowcase

network

(no description)

PcapRecorder IIntegratedVisualizer IL3NetworkConfigurator INetworkConfigurator IGateScheduleConfigurator INetworkConfigurator INetworkConfigurator TsnDevice TsnSwitch TsnSwitch TsnDevice

Usage diagram

The following diagram shows usage relationships between types. Unresolved types are missing from the diagram.

Inheritance diagram

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

Extends

Name Type Description
TsnNetworkBase network

This module serves as a network base module for Time-Sensitive Networking (TSN).

Parameters

Name Type Default value Description
recordPcap bool false
numPcapRecorders int recordPcap ? 1 : 0
hasGlobalArp bool true

Properties

Name Value Description
isNetwork
class NetworkBase

Unassigned submodule parameters

Name Type Default value Description
pcapRecorder.verbose bool true

whether to log packets on the module output
pcapRecorder.pcapFile string ""

the PCAP file to be written
pcapRecorder.fileFormat string "pcapng"
pcapRecorder.snaplen int 65535

maximum number of bytes to record per packet
pcapRecorder.dumpBadFrames bool true

enable dump of frames with hasBitError
pcapRecorder.sendingSignalNames string "packetSentToLower"

space-separated list of outbound packet signals to subscribe to
pcapRecorder.receivingSignalNames string "packetReceivedFromLower"

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
pcapRecorder.displayStringTextFormat string "rec: %n pks"
device1.status.initialStatus string "UP"

TODO @signal, @statistic
device1.pcapRecorder.verbose bool true

whether to log packets on the module output
device1.pcapRecorder.pcapFile string ""

the PCAP file to be written
device1.pcapRecorder.fileFormat string "pcapng"
device1.pcapRecorder.snaplen int 65535

maximum number of bytes to record per packet
device1.pcapRecorder.dumpBadFrames bool true

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

space-separated list of sibling module names to listen on
device1.pcapRecorder.sendingSignalNames string "packetSentToLower"

space-separated list of outbound packet signals to subscribe to
device1.pcapRecorder.receivingSignalNames string "packetReceivedFromLower"

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

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

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

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

flush the pcapFile after each write to ensure that all packets are captured in case of a crash
device1.pcapRecorder.displayStringTextFormat string "rec: %n pks"
device1.interfaceTable.displayAddresses bool false

whether to display IP addresses on links
device1.cb.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
device1.cb.forwardServiceRegistration bool true
device1.cb.forwardProtocolRegistration bool true
device1.bl.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
device1.bl.forwardServiceRegistration bool true
device1.bl.forwardProtocolRegistration bool true
device1.li.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
device1.li.forwardServiceRegistration bool true
device1.li.forwardProtocolRegistration bool true
device1.eth.bitrate double
device1.nl.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
device1.nl.forwardServiceRegistration bool true
device1.nl.forwardProtocolRegistration bool true
device1.tn.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
device1.tn.forwardServiceRegistration bool true
device1.tn.forwardProtocolRegistration bool true
device1.at.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
device1.at.forwardServiceRegistration bool true
device1.at.forwardProtocolRegistration bool true
switch1.macTable.agingTime double
switch1.macTable.forwardingTableFile string
switch1.interfaceTable.displayAddresses bool false

whether to display IP addresses on links
switch1.l2NodeConfigurator.interfaceTableModule string
switch1.l2NodeConfigurator.l2ConfiguratorModule string "l2NetworkConfigurator"

the absolute path to the ~L2NetworkConfigurator; use "" if there is no configurator
switch1.status.initialStatus string "UP"

TODO @signal, @statistic
switch1.pcapRecorder.verbose bool true

whether to log packets on the module output
switch1.pcapRecorder.pcapFile string ""

the PCAP file to be written
switch1.pcapRecorder.fileFormat string "pcapng"
switch1.pcapRecorder.snaplen int 65535

maximum number of bytes to record per packet
switch1.pcapRecorder.dumpBadFrames bool true

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

space-separated list of sibling module names to listen on
switch1.pcapRecorder.sendingSignalNames string "packetSentToLower"

space-separated list of outbound packet signals to subscribe to
switch1.pcapRecorder.receivingSignalNames string "packetReceivedFromLower"

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

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

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

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

flush the pcapFile after each write to ensure that all packets are captured in case of a crash
switch1.pcapRecorder.displayStringTextFormat string "rec: %n pks"
switch1.stp.helloTime double
switch1.stp.forwardDelay double
switch1.stp.maxAge double
switch1.stp.bridgePriority int
switch1.stp.visualize bool
switch1.sc.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
switch1.sc.forwardServiceRegistration bool true
switch1.sc.forwardProtocolRegistration bool true
switch1.cb.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
switch1.cb.forwardServiceRegistration bool true
switch1.cb.forwardProtocolRegistration bool true
switch1.bl.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
switch1.bl.forwardServiceRegistration bool true
switch1.bl.forwardProtocolRegistration bool true
switch1.li.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
switch1.li.forwardServiceRegistration bool true
switch1.li.forwardProtocolRegistration bool true
switch1.cutthrough.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
switch1.cutthrough.forwardServiceRegistration bool true
switch1.cutthrough.forwardProtocolRegistration bool true
switch1.eth.bitrate double
switch2.macTable.agingTime double
switch2.macTable.forwardingTableFile string
switch2.interfaceTable.displayAddresses bool false

whether to display IP addresses on links
switch2.l2NodeConfigurator.interfaceTableModule string
switch2.l2NodeConfigurator.l2ConfiguratorModule string "l2NetworkConfigurator"

the absolute path to the ~L2NetworkConfigurator; use "" if there is no configurator
switch2.status.initialStatus string "UP"

TODO @signal, @statistic
switch2.pcapRecorder.verbose bool true

whether to log packets on the module output
switch2.pcapRecorder.pcapFile string ""

the PCAP file to be written
switch2.pcapRecorder.fileFormat string "pcapng"
switch2.pcapRecorder.snaplen int 65535

maximum number of bytes to record per packet
switch2.pcapRecorder.dumpBadFrames bool true

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

space-separated list of sibling module names to listen on
switch2.pcapRecorder.sendingSignalNames string "packetSentToLower"

space-separated list of outbound packet signals to subscribe to
switch2.pcapRecorder.receivingSignalNames string "packetReceivedFromLower"

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

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

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

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

flush the pcapFile after each write to ensure that all packets are captured in case of a crash
switch2.pcapRecorder.displayStringTextFormat string "rec: %n pks"
switch2.stp.helloTime double
switch2.stp.forwardDelay double
switch2.stp.maxAge double
switch2.stp.bridgePriority int
switch2.stp.visualize bool
switch2.sc.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
switch2.sc.forwardServiceRegistration bool true
switch2.sc.forwardProtocolRegistration bool true
switch2.cb.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
switch2.cb.forwardServiceRegistration bool true
switch2.cb.forwardProtocolRegistration bool true
switch2.bl.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
switch2.bl.forwardServiceRegistration bool true
switch2.bl.forwardProtocolRegistration bool true
switch2.li.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
switch2.li.forwardServiceRegistration bool true
switch2.li.forwardProtocolRegistration bool true
switch2.cutthrough.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
switch2.cutthrough.forwardServiceRegistration bool true
switch2.cutthrough.forwardProtocolRegistration bool true
switch2.eth.bitrate double
device2.status.initialStatus string "UP"

TODO @signal, @statistic
device2.pcapRecorder.verbose bool true

whether to log packets on the module output
device2.pcapRecorder.pcapFile string ""

the PCAP file to be written
device2.pcapRecorder.fileFormat string "pcapng"
device2.pcapRecorder.snaplen int 65535

maximum number of bytes to record per packet
device2.pcapRecorder.dumpBadFrames bool true

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

space-separated list of sibling module names to listen on
device2.pcapRecorder.sendingSignalNames string "packetSentToLower"

space-separated list of outbound packet signals to subscribe to
device2.pcapRecorder.receivingSignalNames string "packetReceivedFromLower"

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

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

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

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

flush the pcapFile after each write to ensure that all packets are captured in case of a crash
device2.pcapRecorder.displayStringTextFormat string "rec: %n pks"
device2.interfaceTable.displayAddresses bool false

whether to display IP addresses on links
device2.cb.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
device2.cb.forwardServiceRegistration bool true
device2.cb.forwardProtocolRegistration bool true
device2.bl.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
device2.bl.forwardServiceRegistration bool true
device2.bl.forwardProtocolRegistration bool true
device2.li.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
device2.li.forwardServiceRegistration bool true
device2.li.forwardProtocolRegistration bool true
device2.eth.bitrate double
device2.nl.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
device2.nl.forwardServiceRegistration bool true
device2.nl.forwardProtocolRegistration bool true
device2.tn.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
device2.tn.forwardServiceRegistration bool true
device2.tn.forwardProtocolRegistration bool true
device2.at.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
device2.at.forwardServiceRegistration bool true
device2.at.forwardProtocolRegistration bool true

Source code

network CutthroughSwitchingShowcase extends TsnNetworkBase
{
    submodules:
        device1: TsnDevice {
            @display("p=350,200");
        }
        switch1: TsnSwitch {
            @display("p=550,200");
        }
        switch2: TsnSwitch {
            @display("p=750,200");
        }
        device2: TsnDevice {
            @display("p=950,200");
        }
    connections:
        device1.ethg++ <--> EthernetLink <--> switch1.ethg++;
        switch1.ethg++ <--> EthernetLink <--> switch2.ethg++;
        switch2.ethg++ <--> EthernetLink <--> device2.ethg++;
}
File: showcases/tsn/cutthroughswitching/CutthroughSwitchingShowcase.ned

This documentation is released under the Creative Commons license