UDPBroadcastNetwork

Package: inet.examples.inet.broadcast

UDPBroadcastNetwork

network

(no description)

StandardHost StandardHost Router Router Ipv4NetworkConfigurator EthernetSwitch StandardHost

Usage diagram

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

Parameters

Name Type Default value Description
numTargets int

Properties

Name Value Description
isNetwork

Unassigned submodule parameters

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

determines the text that is written on top of the submodule
client.at.forwardServiceRegistration bool true
client.at.forwardProtocolRegistration bool true
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" : ""
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)
switch.macTable.agingTime double
switch.macTable.forwardingTableFile string
switch.interfaceTable.displayAddresses bool false

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Source code

network UDPBroadcastNetwork
{
    parameters:
        int numTargets;
    types:
        channel C extends DatarateChannel
        {
            datarate = 10Mbps;
            delay = 0.1us;
        }
    submodules:
        target[numTargets]: StandardHost {
            parameters:
                @display("i=device/pc3;p=850,100,col,100");
        }
        client: StandardHost {
            parameters:
                @display("p=250,200;i=device/pc2");
        }
        R1: Router {
            parameters:
                @display("p=400,200");
        }
        R2: Router {

            @display("p=550,200");
        }
        configurator: Ipv4NetworkConfigurator {
            parameters:
                config = xmldoc("config.xml");
                @display("p=100,100;is=s");
        }
        switch: EthernetSwitch {
            @display("p=700,199");
        }
        nonTarget: StandardHost {
            @display("p=550,100");
        }
    connections:
        client.pppg++ <--> C <--> R1.pppg++;
        R1.pppg++ <--> C <--> R2.pppg++;
        R2.pppg++ <--> C <--> nonTarget.pppg++;
        R2.ethg++ <--> C <--> switch.ethg++;
        for i=0..numTargets-1 {
            switch.ethg++ <--> C <--> target[i].ethg++;
        }
}
File: examples/inet/broadcast/UDPBroadcastNetwork.ned

This documentation is released under the Creative Commons license