ClockDriftShowcase

Package: inet.showcases.tsn.timesynchronization.clockdrift

ClockDriftShowcase

network

(no description)

PcapRecorder IIntegratedVisualizer IL3NetworkConfigurator INetworkConfigurator StandardHost StandardHost EthernetSwitch EthernetSwitch StandardHost StandardHost

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
WiredNetworkBase network (no description)

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"
source1.status.initialStatus string "UP"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

determines the text that is written on top of the submodule
source1.at.forwardServiceRegistration bool true
source1.at.forwardProtocolRegistration bool true
source2.status.initialStatus string "UP"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

determines the text that is written on top of the submodule
source2.at.forwardServiceRegistration bool true
source2.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
sink1.status.initialStatus string "UP"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

determines the text that is written on top of the submodule
sink1.at.forwardServiceRegistration bool true
sink1.at.forwardProtocolRegistration bool true
sink2.status.initialStatus string "UP"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Source code

network ClockDriftShowcase extends WiredNetworkBase
{
    submodules:
        source1: StandardHost {
            @display("p=300,100");
        }
        source2: StandardHost {
            @display("p=300,300");
        }
        switch1: EthernetSwitch {
            @display("p=500,200");
        }
        switch2: EthernetSwitch {
            @display("p=700,200");
        }
        sink1: StandardHost {
            @display("p=900,100");
        }
        sink2: StandardHost {
            @display("p=900,300");
        }
    connections:
        switch1.ethg++ <--> Eth1G <--> switch2.ethg++;
        source1.ethg++ <--> Eth1G <--> switch1.ethg++;
        source2.ethg++ <--> Eth1G <--> switch1.ethg++;
        switch2.ethg++ <--> Eth1G <--> sink1.ethg++;
        switch2.ethg++ <--> Eth1G <--> sink2.ethg++;
}
File: showcases/tsn/timesynchronization/clockdrift/ClockDriftShowcase.ned

This documentation is released under the Creative Commons license