TransmissionTimeMeasurementShowcase

Package: inet.showcases.measurement.transmissiontime

TransmissionTimeMeasurementShowcase

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"); } source : StandardHost A comprehensive model of an IPv4/IPv6 host that provides a complete network stack with configurable... Source: source: StandardHost { @display("p=350,100"); } destination : StandardHost A comprehensive model of an IPv4/IPv6 host that provides a complete network stack with configurable... Source: destination: StandardHost { @display("p=550,100"); }

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
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
source.status.displayStringTextFormat string ""

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
destination.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 TransmissionTimeMeasurementShowcase extends WiredNetworkBase
{
    submodules:
        source: StandardHost {
            @display("p=350,100");
        }
        destination: StandardHost {
            @display("p=550,100");
        }
    connections:
        source.ethg++ <--> Eth100M <--> destination.ethg++;
}
File: showcases/measurement/transmissiontime/TransmissionTimeMeasurementShowcase.ned

This documentation is released under the Creative Commons license