OneMasterClockGptpShowcase

Package: inet.showcases.tsn.timesynchronization.gptp

OneMasterClockGptpShowcase

network

(no description)

pcapRecorder[numPcapRecorders] : PcapRecorder Records PCAP traces of frames sent/received by other modules within the same host. Source: pcapRecorder[numPcapRecorders]: PcapRecorder { parameters: moduleNamePatterns = ".^"; @display("p=100,100;is=s"); } visualizer : like IIntegratedVisualizer IIntegratedVisualizer: Interface allows configuring different ~IIntegratedVisualizer submodules from INI files. Source: visualizer: <default(firstAvailableOrEmpty("IntegratedCanvasVisualizer"))> like IIntegratedVisualizer if typename != "" { parameters: @display("p=100,200;is=s"); } configurator : like IL3NetworkConfigurator Ipv4NetworkConfigurator: Assigns IPv4 addresses and sets up static routing for an IPv4 network. IL3NetworkConfigurator: Interface for all layer 3 network configurators. Source: configurator: <default("Ipv4NetworkConfigurator")> like IL3NetworkConfigurator if typename != "" { parameters: @display("p=100,300;is=s"); } moduleDump[numModuleDumps] : ModuleDump Source: moduleDump[numModuleDumps]: ModuleDump { parameters: @display("p=100,400;is=s"); } macForwardingTableConfigurator : like INetworkConfigurator INetworkConfigurator: Interface for all network-wide configurator modules. Source: macForwardingTableConfigurator: <default(hasGlobalArp ? "MacForwardingTableConfigurator" : "")> like INetworkConfigurator if typename != "" { @display("p=100,400;is=s"); } gateScheduleConfigurator : like IGateScheduleConfigurator IGateScheduleConfigurator: Interface for gate scheduling configurator modules. Source: gateScheduleConfigurator: <default("")> like IGateScheduleConfigurator if typename != "" { @display("p=100,500;is=s"); } streamRedundancyConfigurator : like INetworkConfigurator INetworkConfigurator: Interface for all network-wide configurator modules. Source: streamRedundancyConfigurator: <default("")> like INetworkConfigurator if typename != "" { @display("p=100,600;is=s"); } failureProtectionConfigurator : like INetworkConfigurator INetworkConfigurator: Interface for all network-wide configurator modules. Source: failureProtectionConfigurator: <default("")> like INetworkConfigurator if typename != "" { @display("p=100,700;is=s"); } tsnClock : TsnClock A specialized network device that serves as the master clock for Time-Sensitive Networking (TSN)... Source: tsnClock: TsnClock { @display("p=500,150"); } tsnSwitch : TsnSwitch An Ethernet switch with Time-Sensitive Networking (TSN) capabilities. Source: tsnSwitch: TsnSwitch { @display("p=500,300"); } tsnDevice1 : TsnDevice An end device with Time-Sensitive Networking (TSN) capabilities. Source: tsnDevice1: TsnDevice { @display("p=400,450"); } tsnDevice2 : TsnDevice An end device with Time-Sensitive Networking (TSN) capabilities. Source: tsnDevice2: TsnDevice { @display("p=600,450"); }

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

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

Parameters

Name Type Default value Description
displayStringTextFormat string ""

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
recordPcap bool false
numPcapRecorders int recordPcap ? 1 : 0
numModuleDumps int 0
hasGlobalArp bool true

Properties

Name Value Description
class NetworkBase
isNetwork

Unassigned submodule parameters

Name Type Default value Description
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.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
moduleDump.modulePath string "^"
moduleDump.fileName string ""
moduleDump.time double 0
moduleDump.printClassNames bool false
moduleDump.printProperties bool false
moduleDump.printParamAssignmentLocations bool false
tsnClock.status.displayStringTextFormat string ""

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

TODO @signal, @statistic
tsnClock.environment.displayStringTextFormat string ""

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
tsnClock.environment.initStage int 0

Initialization stage for the setup command
tsnClock.environment.globalNamespace bool false

Create new network namespaces under /var/run/netns/ (Linux only)
tsnClock.environment.namespace string ""

Name of the host OS network namespace (optional) (Linux only)
tsnClock.environment.setupCommand string ""

A host OS system command
tsnClock.environment.teardownCommand string ""

A host OS system command
tsnClock.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
tsnClock.pcapRecorder.verbose bool true

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

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

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

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

Maximum number of bytes to record per packet
tsnClock.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).
tsnClock.pcapRecorder.dumpBadFrames bool true

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

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

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

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

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

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

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

Flush the pcapFile after each write to ensure that all packets are captured in case of a crash
tsnClock.interfaceTable.displayStringTextFormat string ""

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

Whether to display IP addresses on links
tsnClock.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
tsnClock.cb.interfaceTableModule string

Module path to the ~InterfaceTable module
tsnClock.cb.forwardServiceRegistration bool true
tsnClock.cb.forwardProtocolRegistration bool true
tsnClock.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
tsnClock.cb.serviceMapping object {}

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

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
tsnClock.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
tsnClock.bl.interfaceTableModule string

Module path to the ~InterfaceTable module
tsnClock.bl.forwardServiceRegistration bool true
tsnClock.bl.forwardProtocolRegistration bool true
tsnClock.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
tsnClock.bl.serviceMapping object {}

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

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
tsnClock.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
tsnClock.li.interfaceTableModule string

Module path to the ~InterfaceTable module
tsnClock.li.forwardServiceRegistration bool true
tsnClock.li.forwardProtocolRegistration bool true
tsnClock.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
tsnClock.li.serviceMapping object {}

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

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
tsnClock.eth.bitrate double
tsnClock.nl.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
tsnClock.nl.interfaceTableModule string

Module path to the ~InterfaceTable module
tsnClock.nl.forwardServiceRegistration bool true
tsnClock.nl.forwardProtocolRegistration bool true
tsnClock.nl.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
tsnClock.nl.serviceMapping object {}

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

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
tsnClock.tn.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
tsnClock.tn.interfaceTableModule string

Module path to the ~InterfaceTable module
tsnClock.tn.forwardServiceRegistration bool true
tsnClock.tn.forwardProtocolRegistration bool true
tsnClock.tn.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
tsnClock.tn.serviceMapping object {}

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

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
tsnClock.at.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
tsnClock.at.interfaceTableModule string

Module path to the ~InterfaceTable module
tsnClock.at.forwardServiceRegistration bool true
tsnClock.at.forwardProtocolRegistration bool true
tsnClock.at.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
tsnClock.at.serviceMapping object {}

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

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
tsnSwitch.macTable.agingTime double
tsnSwitch.macTable.forwardingTableFile string
tsnSwitch.interfaceTable.displayStringTextFormat string ""

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

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

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

TODO @signal, @statistic
tsnSwitch.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
tsnSwitch.pcapRecorder.verbose bool true

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

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

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

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

Maximum number of bytes to record per packet
tsnSwitch.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).
tsnSwitch.pcapRecorder.dumpBadFrames bool true

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

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

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

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

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

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

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

Flush the pcapFile after each write to ensure that all packets are captured in case of a crash
tsnSwitch.mrp.ccmInterval double
tsnSwitch.mrp.mrpRole string
tsnSwitch.mrp.timingProfile int
tsnSwitch.mrp.uuid0 int
tsnSwitch.mrp.uuid1 int
tsnSwitch.mrp.ringPort1 int
tsnSwitch.mrp.ringPort2 int
tsnSwitch.mrp.interconnectionLinkCheckAware bool
tsnSwitch.mrp.interconnectionRingCheckAware bool
tsnSwitch.mrp.nonblockingMrcSupported bool
tsnSwitch.mrp.reactOnLinkChange bool
tsnSwitch.mrp.visualize bool
tsnSwitch.stp.helloTime double
tsnSwitch.stp.forwardDelay double
tsnSwitch.stp.maxAge double
tsnSwitch.stp.bridgePriority int
tsnSwitch.stp.visualize bool
tsnSwitch.gptp.gptpNodeType string "BRIDGE_NODE"
tsnSwitch.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
tsnSwitch.sc.interfaceTableModule string

Module path to the ~InterfaceTable module
tsnSwitch.sc.forwardServiceRegistration bool true
tsnSwitch.sc.forwardProtocolRegistration bool true
tsnSwitch.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
tsnSwitch.sc.serviceMapping object {}

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

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
tsnSwitch.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
tsnSwitch.cb.interfaceTableModule string

Module path to the ~InterfaceTable module
tsnSwitch.cb.forwardServiceRegistration bool true
tsnSwitch.cb.forwardProtocolRegistration bool true
tsnSwitch.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
tsnSwitch.cb.serviceMapping object {}

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

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
tsnSwitch.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
tsnSwitch.bl.interfaceTableModule string

Module path to the ~InterfaceTable module
tsnSwitch.bl.forwardServiceRegistration bool true
tsnSwitch.bl.forwardProtocolRegistration bool true
tsnSwitch.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
tsnSwitch.bl.serviceMapping object {}

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

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
tsnSwitch.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
tsnSwitch.li.interfaceTableModule string

Module path to the ~InterfaceTable module
tsnSwitch.li.forwardServiceRegistration bool true
tsnSwitch.li.forwardProtocolRegistration bool true
tsnSwitch.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
tsnSwitch.li.serviceMapping object {}

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

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

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

TODO @signal, @statistic
tsnDevice1.environment.displayStringTextFormat string ""

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
tsnDevice1.environment.initStage int 0

Initialization stage for the setup command
tsnDevice1.environment.globalNamespace bool false

Create new network namespaces under /var/run/netns/ (Linux only)
tsnDevice1.environment.namespace string ""

Name of the host OS network namespace (optional) (Linux only)
tsnDevice1.environment.setupCommand string ""

A host OS system command
tsnDevice1.environment.teardownCommand string ""

A host OS system command
tsnDevice1.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
tsnDevice1.pcapRecorder.verbose bool true

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

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

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

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

Maximum number of bytes to record per packet
tsnDevice1.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).
tsnDevice1.pcapRecorder.dumpBadFrames bool true

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

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

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

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

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

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

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

Flush the pcapFile after each write to ensure that all packets are captured in case of a crash
tsnDevice1.interfaceTable.displayStringTextFormat string ""

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

Whether to display IP addresses on links
tsnDevice1.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
tsnDevice1.cb.interfaceTableModule string

Module path to the ~InterfaceTable module
tsnDevice1.cb.forwardServiceRegistration bool true
tsnDevice1.cb.forwardProtocolRegistration bool true
tsnDevice1.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
tsnDevice1.cb.serviceMapping object {}

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

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
tsnDevice1.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
tsnDevice1.bl.interfaceTableModule string

Module path to the ~InterfaceTable module
tsnDevice1.bl.forwardServiceRegistration bool true
tsnDevice1.bl.forwardProtocolRegistration bool true
tsnDevice1.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
tsnDevice1.bl.serviceMapping object {}

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

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
tsnDevice1.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
tsnDevice1.li.interfaceTableModule string

Module path to the ~InterfaceTable module
tsnDevice1.li.forwardServiceRegistration bool true
tsnDevice1.li.forwardProtocolRegistration bool true
tsnDevice1.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
tsnDevice1.li.serviceMapping object {}

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

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
tsnDevice1.eth.bitrate double
tsnDevice1.nl.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
tsnDevice1.nl.interfaceTableModule string

Module path to the ~InterfaceTable module
tsnDevice1.nl.forwardServiceRegistration bool true
tsnDevice1.nl.forwardProtocolRegistration bool true
tsnDevice1.nl.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
tsnDevice1.nl.serviceMapping object {}

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

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
tsnDevice1.tn.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
tsnDevice1.tn.interfaceTableModule string

Module path to the ~InterfaceTable module
tsnDevice1.tn.forwardServiceRegistration bool true
tsnDevice1.tn.forwardProtocolRegistration bool true
tsnDevice1.tn.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
tsnDevice1.tn.serviceMapping object {}

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

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
tsnDevice1.at.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
tsnDevice1.at.interfaceTableModule string

Module path to the ~InterfaceTable module
tsnDevice1.at.forwardServiceRegistration bool true
tsnDevice1.at.forwardProtocolRegistration bool true
tsnDevice1.at.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
tsnDevice1.at.serviceMapping object {}

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

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
tsnDevice2.status.displayStringTextFormat string ""

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

TODO @signal, @statistic
tsnDevice2.environment.displayStringTextFormat string ""

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
tsnDevice2.environment.initStage int 0

Initialization stage for the setup command
tsnDevice2.environment.globalNamespace bool false

Create new network namespaces under /var/run/netns/ (Linux only)
tsnDevice2.environment.namespace string ""

Name of the host OS network namespace (optional) (Linux only)
tsnDevice2.environment.setupCommand string ""

A host OS system command
tsnDevice2.environment.teardownCommand string ""

A host OS system command
tsnDevice2.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
tsnDevice2.pcapRecorder.verbose bool true

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

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

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

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

Maximum number of bytes to record per packet
tsnDevice2.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).
tsnDevice2.pcapRecorder.dumpBadFrames bool true

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

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

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

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

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

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

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

Flush the pcapFile after each write to ensure that all packets are captured in case of a crash
tsnDevice2.interfaceTable.displayStringTextFormat string ""

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

Whether to display IP addresses on links
tsnDevice2.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
tsnDevice2.cb.interfaceTableModule string

Module path to the ~InterfaceTable module
tsnDevice2.cb.forwardServiceRegistration bool true
tsnDevice2.cb.forwardProtocolRegistration bool true
tsnDevice2.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
tsnDevice2.cb.serviceMapping object {}

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

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
tsnDevice2.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
tsnDevice2.bl.interfaceTableModule string

Module path to the ~InterfaceTable module
tsnDevice2.bl.forwardServiceRegistration bool true
tsnDevice2.bl.forwardProtocolRegistration bool true
tsnDevice2.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
tsnDevice2.bl.serviceMapping object {}

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

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
tsnDevice2.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
tsnDevice2.li.interfaceTableModule string

Module path to the ~InterfaceTable module
tsnDevice2.li.forwardServiceRegistration bool true
tsnDevice2.li.forwardProtocolRegistration bool true
tsnDevice2.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
tsnDevice2.li.serviceMapping object {}

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

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
tsnDevice2.eth.bitrate double
tsnDevice2.nl.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
tsnDevice2.nl.interfaceTableModule string

Module path to the ~InterfaceTable module
tsnDevice2.nl.forwardServiceRegistration bool true
tsnDevice2.nl.forwardProtocolRegistration bool true
tsnDevice2.nl.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
tsnDevice2.nl.serviceMapping object {}

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

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
tsnDevice2.tn.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
tsnDevice2.tn.interfaceTableModule string

Module path to the ~InterfaceTable module
tsnDevice2.tn.forwardServiceRegistration bool true
tsnDevice2.tn.forwardProtocolRegistration bool true
tsnDevice2.tn.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
tsnDevice2.tn.serviceMapping object {}

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

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
tsnDevice2.at.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
tsnDevice2.at.interfaceTableModule string

Module path to the ~InterfaceTable module
tsnDevice2.at.forwardServiceRegistration bool true
tsnDevice2.at.forwardProtocolRegistration bool true
tsnDevice2.at.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
tsnDevice2.at.serviceMapping object {}

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

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

Source code

network OneMasterClockGptpShowcase extends TsnNetworkBase
{
    submodules:
        tsnClock: TsnClock {
            @display("p=500,150");
        }
        tsnSwitch: TsnSwitch {
            @display("p=500,300");
        }
        tsnDevice1: TsnDevice {
            @display("p=400,450");
        }
        tsnDevice2: TsnDevice {
            @display("p=600,450");
        }
    connections:
        tsnClock.ethg++ <--> EthernetLink <--> tsnSwitch.ethg++;
        tsnSwitch.ethg++ <--> EthernetLink <--> tsnDevice1.ethg++;
        tsnSwitch.ethg++ <--> EthernetLink <--> tsnDevice2.ethg++;
}
File: showcases/tsn/timesynchronization/gptp/GptpShowcase.ned

This documentation is released under the Creative Commons license