QosThroughput

Package: inet.examples.wireless.qos

QosThroughput

network

(no description)

configurator : Ipv4NetworkConfigurator Assigns IPv4 addresses and sets up static routing for an IPv4 network. Source: configurator: Ipv4NetworkConfigurator { @display("p=100,100;is=s"); } ap : AccessPoint A wireless access point device that connects wireless stations (like WirelessHost) to a wired... Source: ap: AccessPoint { parameters: @display("p=400,200;r=,,#707070"); } srvHost : WirelessHost A mobile device with wireless connectivity operating in infrastructure mode. Source: srvHost: WirelessHost { parameters: @display("r=,,#707070;p=550,100"); } cliHost : WirelessHost A mobile device with wireless connectivity operating in infrastructure mode. Source: cliHost: WirelessHost { parameters: @display("r=,,#707070;p=250,100"); } radioMedium : Ieee80211ScalarRadioMedium This radio medium model uses scalar transmission power in the analog representation. Source: radioMedium: Ieee80211ScalarRadioMedium { parameters: @display("p=100,200;is=s"); }

Usage diagram

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

Properties

Name Value Description
isNetwork

Unassigned submodule parameters

Name Type Default value Description
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)
ap.status.displayStringTextFormat string ""

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

TODO @signal, @statistic
ap.interfaceTable.displayStringTextFormat string ""

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

Whether to display IP addresses on links
ap.macTable.agingTime double
ap.macTable.forwardingTableFile string
ap.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
ap.bl.interfaceTableModule string

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Source code

network QosThroughput
{
    parameters:
    submodules:
        configurator: Ipv4NetworkConfigurator {
            @display("p=100,100;is=s");
        }
        ap: AccessPoint {
            parameters:
                @display("p=400,200;r=,,#707070");
        }
        srvHost: WirelessHost {
            parameters:
                @display("r=,,#707070;p=550,100");
        }
        cliHost: WirelessHost {
            parameters:
                @display("r=,,#707070;p=250,100");
        }
        radioMedium: Ieee80211ScalarRadioMedium {
            parameters:
                @display("p=100,200;is=s");
        }
}
File: examples/wireless/qos/Throughput.ned

This documentation is released under the Creative Commons license