RTPMulticast1

Package: inet.examples.rtp.multicast1

RTPMulticast1

network

(no description)

RtpHost RtpHost RtpHost RtpHost Router 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
host1.status.initialStatus string "UP"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

determines the text that is written on top of the submodule
host1.at.forwardServiceRegistration bool true
host1.at.forwardProtocolRegistration bool true
host1.rtpApp.commonName string

the common name (CNAME) of this host
host1.rtpApp.sessionEnterDelay double

delay before starts a new session
host1.rtpApp.transmissionStartDelay double

delay before start transmission (related to "sender module created")
host1.rtpApp.transmissionStopDelay double

delay before stops transmission (related to "start transmission")
host1.rtpApp.sessionLeaveDelay double

delay before leave session (related to "file transmission finished/stopped" or "session entered" when fileName is "")
host1.rtp.interfaceTableModule string

The path to the InterfaceTable module
host1.rtp.routingTableModule string
host1.rtcp.interfaceTableModule string

The path to the InterfaceTable module
host2.status.initialStatus string "UP"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

determines the text that is written on top of the submodule
host2.at.forwardServiceRegistration bool true
host2.at.forwardProtocolRegistration bool true
host2.rtpApp.commonName string

the common name (CNAME) of this host
host2.rtpApp.sessionEnterDelay double

delay before starts a new session
host2.rtpApp.transmissionStartDelay double

delay before start transmission (related to "sender module created")
host2.rtpApp.transmissionStopDelay double

delay before stops transmission (related to "start transmission")
host2.rtpApp.sessionLeaveDelay double

delay before leave session (related to "file transmission finished/stopped" or "session entered" when fileName is "")
host2.rtp.interfaceTableModule string

The path to the InterfaceTable module
host2.rtp.routingTableModule string
host2.rtcp.interfaceTableModule string

The path to the InterfaceTable module
host3.status.initialStatus string "UP"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

determines the text that is written on top of the submodule
host3.at.forwardServiceRegistration bool true
host3.at.forwardProtocolRegistration bool true
host3.rtpApp.commonName string

the common name (CNAME) of this host
host3.rtpApp.sessionEnterDelay double

delay before starts a new session
host3.rtpApp.transmissionStartDelay double

delay before start transmission (related to "sender module created")
host3.rtpApp.transmissionStopDelay double

delay before stops transmission (related to "start transmission")
host3.rtpApp.sessionLeaveDelay double

delay before leave session (related to "file transmission finished/stopped" or "session entered" when fileName is "")
host3.rtp.interfaceTableModule string

The path to the InterfaceTable module
host3.rtp.routingTableModule string
host3.rtcp.interfaceTableModule string

The path to the InterfaceTable module
host4.status.initialStatus string "UP"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

determines the text that is written on top of the submodule
host4.at.forwardServiceRegistration bool true
host4.at.forwardProtocolRegistration bool true
host4.rtpApp.commonName string

the common name (CNAME) of this host
host4.rtpApp.sessionEnterDelay double

delay before starts a new session
host4.rtpApp.transmissionStartDelay double

delay before start transmission (related to "sender module created")
host4.rtpApp.transmissionStopDelay double

delay before stops transmission (related to "start transmission")
host4.rtpApp.sessionLeaveDelay double

delay before leave session (related to "file transmission finished/stopped" or "session entered" when fileName is "")
host4.rtp.interfaceTableModule string

The path to the InterfaceTable module
host4.rtp.routingTableModule string
host4.rtcp.interfaceTableModule string

The path to the InterfaceTable module
router1.status.initialStatus string "UP"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

The path to the InterfaceTable module
router1.bgp.routingTableModule string
router1.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)

Source code

network RTPMulticast1
{
    types:
        channel ethernet extends DatarateChannel
        {
            delay = normal(0.00015s, 0.00005s);
            datarate = 10Mbps;
        }
    submodules:
        host1: RtpHost {
            parameters:
                forwarding = false;
                profileName = "inet.transportlayer.rtp.RtpAvProfile";
                destinationAddress = "225.0.0.1";
                portNumber = 5004;
                bandwidth = 8000;
                @display("p=400,100");
        }
        host2: RtpHost {
            parameters:
                forwarding = false;
                profileName = "inet.transportlayer.rtp.RtpAvProfile";
                destinationAddress = "225.0.0.1";
                portNumber = 5004;
                bandwidth = 8000;
                @display("p=550,230");
        }
        host3: RtpHost {
            parameters:
                forwarding = false;
                profileName = "inet.transportlayer.rtp.RtpAvProfile";
                destinationAddress = "225.0.0.1";
                portNumber = 5004;
                bandwidth = 8000;
                @display("p=400,360");
        }
        host4: RtpHost {
            parameters:
                forwarding = false;
                profileName = "inet.transportlayer.rtp.RtpAvProfile";
                destinationAddress = "225.0.0.1";
                portNumber = 5004;
                bandwidth = 8000;
                @display("p=250,230");
        }
        router1: Router {
            parameters:
                multicastForwarding = true;
                @display("p=400,230");
            gates:
                pppg[];

        }
        configurator: Ipv4NetworkConfigurator {
            config = xml("<config>"
                +"<interface hosts='**' address='10.x.x.x' netmask='255.x.x.x'/>"
                +"<multicast-group hosts='**' address='225.0.0.1'/>"
                +"<multicast-route hosts='router1' groups='225.0.0.1' children='ppp*'/>"
                +"</config>");
            @display("p=100,100;is=s");
        }
    connections:
        host1.pppg++ <--> ethernet <--> router1.pppg++;
        host2.pppg++ <--> ethernet <--> router1.pppg++;
        host3.pppg++ <--> ethernet <--> router1.pppg++;
        host4.pppg++ <--> ethernet <--> router1.pppg++;
}
File: examples/rtp/multicast1/multicast1.ned

This documentation is released under the Creative Commons license