NClients

Package: inet.examples.inet.shutdownrestart

NClients

network

(no description)

Router Router Router EthernetSwitch StandardHost StandardHost Ipv4NetworkConfigurator ScenarioManager

Usage diagram

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

Parameters

Name Type Default value Description
n int

Properties

Name Value Description
isNetwork

Unassigned submodule parameters

Name Type Default value Description
r1.status.initialStatus string "UP"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

determines the text that is written on top of the submodule
r1.at.forwardServiceRegistration bool true
r1.at.forwardProtocolRegistration bool true
r1.bgp.interfaceTableModule string

The path to the InterfaceTable module
r1.bgp.routingTableModule string
r1.bgp.ospfRoutingModule string parent.hasOspf ? "^.ospf" : ""
r2.status.initialStatus string "UP"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

determines the text that is written on top of the submodule
r2.at.forwardServiceRegistration bool true
r2.at.forwardProtocolRegistration bool true
r2.bgp.interfaceTableModule string

The path to the InterfaceTable module
r2.bgp.routingTableModule string
r2.bgp.ospfRoutingModule string parent.hasOspf ? "^.ospf" : ""
r3.status.initialStatus string "UP"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

determines the text that is written on top of the submodule
r3.at.forwardServiceRegistration bool true
r3.at.forwardProtocolRegistration bool true
r3.bgp.interfaceTableModule string

The path to the InterfaceTable module
r3.bgp.routingTableModule string
r3.bgp.ospfRoutingModule string parent.hasOspf ? "^.ospf" : ""
s.macTable.agingTime double
s.macTable.forwardingTableFile string
s.interfaceTable.displayAddresses bool false

whether to display IP addresses on links
s.l2NodeConfigurator.interfaceTableModule string
s.l2NodeConfigurator.l2ConfiguratorModule string "l2NetworkConfigurator"

the absolute path to the ~L2NetworkConfigurator; use "" if there is no configurator
s.status.initialStatus string "UP"

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

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

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

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

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

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

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

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

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

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

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

flush the pcapFile after each write to ensure that all packets are captured in case of a crash
s.pcapRecorder.displayStringTextFormat string "rec: %n pks"
s.stp.helloTime double
s.stp.forwardDelay double
s.stp.maxAge double
s.stp.bridgePriority int
s.stp.visualize bool
s.sc.displayStringTextFormat string "processed %p pk (%l)"

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

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

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

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

determines the text that is written on top of the submodule
s.cutthrough.forwardServiceRegistration bool true
s.cutthrough.forwardProtocolRegistration bool true
s.eth.bitrate double
cli.status.initialStatus string "UP"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

determines the text that is written on top of the submodule
srv.at.forwardServiceRegistration bool true
srv.at.forwardProtocolRegistration bool true
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 (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.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)
scenarioManager.script xml xml("")

Source code

network NClients
{
    parameters:
        int n;
    types:
        channel fiberline extends ThruputMeteringChannel
        {
            delay = 1us;
            datarate = 512Mbps;
            thruputDisplayFormat = "u";
        }
        channel ethernetline extends ThruputMeteringChannel
        {
            delay = 0.1us;
            datarate = 10Mbps;
            thruputDisplayFormat = "u";
        }
    submodules:
        r1: Router {
            @display("p=500,150");
        }
        r2: Router {
            @display("p=650,150");
        }
        r3: Router {
            @display("p=800,150");
        }
        s: EthernetSwitch {
            @display("p=350,150");
        }
        cli[n]: StandardHost {
            @display("i=device/laptop;p=250,100,col,100");
        }
        srv: StandardHost {
            @display("p=950,150;i=device/server");
        }
        configurator: Ipv4NetworkConfigurator {
            @display("p=100,100;is=s");
        }
        scenarioManager: ScenarioManager {
            @display("p=100,200;is=s");
        }
    connections:
        for i=0..n-1 {
            cli[i].ethg++ <--> ethernetline <--> s.ethg++;
        }
        s.ethg++ <--> ethernetline <--> r1.ethg++;
        r1.pppg++ <--> ethernetline <--> r2.pppg++;
        r2.pppg++ <--> ethernetline <--> r3.pppg++;
        r3.pppg++ <--> ethernetline <--> srv.pppg++;
}
File: examples/inet/shutdownrestart/NClients.ned

This documentation is released under the Creative Commons license