Voip

Package: inet.examples.voip

Voip

network

A generated network with star topology.

StandardHost StandardHost Ipv4NetworkConfigurator InternetCloud

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

determines the text that is written on top of the submodule
receiverHost.at.forwardServiceRegistration bool true
receiverHost.at.forwardProtocolRegistration bool true
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)
internetCloud.status.initialStatus string "UP"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

determines the text that is written on top of the submodule
internetCloud.nl.forwardServiceRegistration bool true
internetCloud.nl.forwardProtocolRegistration bool true

Source code

//
// A generated network with star topology.
//
network Voip
{
    types:
        channel C extends DatarateChannel
        {
            datarate = 100Mbps;
            delay = 0.1us;
        }
    submodules:
        senderHost: StandardHost {
            parameters:
                @display("p=250,100");
        }
        receiverHost: StandardHost {
            parameters:
                @display("p=650,100");
        }
        configurator: Ipv4NetworkConfigurator {
            @display("p=100,100;is=s");
        }
        internetCloud: InternetCloud {
            @display("p=450,100;is=vl");
        }
    connections:
        senderHost.pppg++ <--> C <--> internetCloud.pppg++;
        internetCloud.pppg++ <--> C <--> receiverHost.pppg++;
}
File: examples/voip/Voip.ned

This documentation is released under the Creative Commons license