Network

Package: inet.examples.inet.igmp

Network

network

TODO documentation

StandardHost Router Router StandardHost StandardHost EthernetSwitch Ipv4NetworkConfigurator

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
Alice.status.initialStatus string "UP"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

determines the text that is written on top of the submodule
Carlos.at.forwardServiceRegistration bool true
Carlos.at.forwardProtocolRegistration bool true
etherSwitch.macTable.agingTime double
etherSwitch.macTable.forwardingTableFile string
etherSwitch.interfaceTable.displayAddresses bool false

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

determines the text that is written on top of the submodule
etherSwitch.cutthrough.forwardServiceRegistration bool true
etherSwitch.cutthrough.forwardProtocolRegistration bool true
etherSwitch.eth.bitrate double
configurator.minLinkWeight double 1E-3
configurator.configureIsolatedNetworksSeparatly bool false
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)

Source code

//
// TODO documentation
//
network Network
{
    submodules:
        Alice: StandardHost {
            @display("p=250,100");
        }
        FITgate1: Router {
            @display("p=550,100");
        }
        FITgate2: Router {
            @display("p=550,200");
        }
        Bob: StandardHost {
            @display("p=250,200");
        }
        Carlos: StandardHost {
            @display("p=550,300");
        }
        etherSwitch: EthernetSwitch {
            @display("p=400,150");
        }
        configurator: Ipv4NetworkConfigurator {
            @display("p=100,100;is=s");
            config = xmldoc("config.xml");
        }
    connections allowunconnected:
        Alice.ethg++ <--> Eth100M <--> etherSwitch.ethg++;
        Bob.ethg++ <--> Eth100M <--> etherSwitch.ethg++;
        FITgate1.ethg++ <--> Eth100M <--> etherSwitch.ethg++;
        FITgate2.ethg++ <--> Eth100M <--> etherSwitch.ethg++;
        Carlos.ethg++ <--> Eth100M <--> FITgate2.ethg++;
}
File: examples/inet/igmp/Network.ned

This documentation is released under the Creative Commons license