Throughput

Package: inet.showcases.wireless.throughput

Throughput

network

(no description)

sourceHost : WirelessHost A mobile device with wireless connectivity operating in infrastructure mode. Source: sourceHost: WirelessHost { @display("p=3,2"); } destinationHost : WirelessHost A mobile device with wireless connectivity operating in infrastructure mode. Source: destinationHost: WirelessHost { @display("p=4,2"); } configurator : Ipv4NetworkConfigurator Assigns IPv4 addresses and sets up static routing for an IPv4 network. Source: configurator: Ipv4NetworkConfigurator { @display("p=0.5,0.5"); } radioMedium : Ieee80211ScalarRadioMedium This radio medium model uses scalar transmission power in the analog representation. Source: radioMedium: Ieee80211ScalarRadioMedium { @display("p=0.5,1"); }

Usage diagram

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

Properties

Name Value Description
isNetwork
display bgb=6,4

Statistics

Name Title Source Record Unit Interpolation Mode Description
numRcvdPk count(destinationHost.app[0].packetReceived) figure
throughput liveThroughput(destinationHost.app[0].packetReceived)/1000000 figure

Unassigned submodule parameters

Name Type Default value Description
sourceHost.status.displayStringTextFormat string ""

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
configurator.minLinkWeight double 1E-3
configurator.configureIsolatedNetworksSeparatly bool false
configurator.config xml xml("")

XML configuration parameters for IP address assignment and adding manual routes
configurator.assignAddresses bool true

Assign IP addresses to all interfaces in the network
configurator.assignUniqueAddresses bool true

Avoid using the same address and raise an error if not possible
configurator.assignDisjunctSubnetAddresses bool true

Avoid using the same address prefix and netmask on different links when assigning IP addresses to interfaces
configurator.addStaticRoutes bool true

Add static routes to the routing tables of all nodes to route to all destination interfaces (only where applicable; turn off when config file contains manual routes)
configurator.addDefaultRoutes bool true

Add default routes if all routes from a source node go through the same gateway (used only if addStaticRoutes is true)
configurator.addSubnetRoutes bool true

Add subnet routes instead of destination interface routes (only where applicable; used only if addStaticRoutes is true)
configurator.addDirectRoutes bool true

Add direct routes towards local network members (i.e. directly connected interfaces) to the routing table (used only if addStaticRoutes is true)
configurator.optimizeRoutes bool true

Optimize routing tables by merging routes, the resulting routing table might route more packets than the original (used only if addStaticRoutes is true)
configurator.updateRoutes bool false

Recalculate static routes if an interface goes down/up or a carrier is lost/back
configurator.dumpTopology bool false

Print extracted network topology to the module output
configurator.dumpLinks bool false

Print recognized network links to the module output
configurator.dumpAddresses bool false

Print assigned IP addresses for all interfaces to the module output
configurator.dumpRoutes bool false

Print configured and optimized routing tables for all nodes to the module output
configurator.dumpConfig string ""

Write configuration into the given config file that can be fed back to speed up subsequent runs (network configurations)
radioMedium.neighborCache.refillPeriod double

Source code

network Throughput
{
    @display("bgb=6,4");
    @statistic[throughput](source=liveThroughput(destinationHost.app[0].packetReceived)/1000000; record=figure; targetFigure=panel.throughput; checkSignals=false);
    @statistic[numRcvdPk](source=count(destinationHost.app[0].packetReceived); record=figure; targetFigure=panel.numRcvdPkCounter; checkSignals=false);
    @figure[panel](type=panel; pos=1.5,0.1);
    //    @figure[panel.throughput](type=gauge; pos=0,0; size=100,100; minValue=0; maxValue=40; tickSize=5; label="App level throughput [Mbps]");
    @figure[panel.throughput](type=linearGauge; pos=250,50; size=250,30; minValue=0; maxValue=54; tickSize=6; label="Application level throughput [Mbps]");
    @figure[panel.numRcvdPkCounter](type=counter; pos=50,50; label="Packets received"; decimalPlaces=6);
    submodules:
        sourceHost: WirelessHost {
            @display("p=3,2");
        }
        destinationHost: WirelessHost {
            @display("p=4,2");
        }
        configurator: Ipv4NetworkConfigurator {
            @display("p=0.5,0.5");
        }
        radioMedium: Ieee80211ScalarRadioMedium {
            @display("p=0.5,1");
        }
}
File: showcases/wireless/throughput/Throughput.ned

This documentation is released under the Creative Commons license