SimpleConfiguratorNetwork

Package: inet.examples.inet.configurator

SimpleConfiguratorNetwork

network

(no description)

Ipv4NetworkConfigurator StandardHost StandardHost StandardHost StandardHost

Usage diagram

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

Properties

Name Value Description
isNetwork
display bgb=450,300

Unassigned submodule parameters

Name Type Default value Description
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)
host11.status.initialStatus string "UP"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Source code

network SimpleConfiguratorNetwork
{
    @display("bgb=450,300");
    submodules:
        configurator: Ipv4NetworkConfigurator {
            parameters:
                @display("p=100,100;is=s");
        }
        host11: StandardHost {
            parameters:
                @display("p=250,100");
        }
        host21: StandardHost {
            parameters:
                @display("p=400,100");
        }
        host12: StandardHost {
            parameters:
                @display("p=250,250");
        }
        host22: StandardHost {
            parameters:
                @display("p=400,250");
        }
    connections allowunconnected:
        host11.ethg++ <--> Eth1G <--> host21.ethg++;
        host11.ethg++ <--> Eth1G <--> host12.ethg++;
        host21.ethg++ <--> Eth1G <--> host22.ethg++;
        host12.ethg++ <--> Eth1G <--> host22.ethg++;
}
File: examples/inet/configurator/SimpleConfiguratorNetwork.ned

This documentation is released under the Creative Commons license