UDPBurst

Package: inet.examples.inet.udpburst

UDPBurst

network

(no description)

StandardHost StandardHost Router Ipv4NetworkConfigurator

Usage diagram

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

Parameters

Name Type Default value Description
numhosts int

Properties

Name Value Description
isNetwork

Unassigned submodule parameters

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

The path to the InterfaceTable module
router.bgp.routingTableModule string
router.bgp.ospfRoutingModule string parent.hasOspf ? "^.ospf" : ""
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)

Source code

network UDPBurst
{
    parameters:
        int numhosts;
    types:
        channel C extends DatarateChannel
        {
            datarate = 1Mbps;
            delay = 0.1us;
        }
    submodules:
        host[numhosts]: StandardHost {
            parameters:
                @display("i=device/pc3");
        }
        sink: StandardHost {
            parameters:
                @display("p=250,300;i=device/pc2");
        }
        router: Router {
            parameters:
                @display("p=250,200");
        }
        configurator: Ipv4NetworkConfigurator {
            parameters:
                @display("p=100,100;is=s");
        }
    connections:
        for i=0..numhosts-1 {
            host[i].pppg++ <--> C <--> router.pppg++;
        }
        sink.pppg++ <--> C <--> router.pppg++;
}
File: examples/inet/udpburst/UDPBurst.ned

This documentation is released under the Creative Commons license