Tunnel

Package: inet.examples.inet.tunnel

Tunnel

network

(no description)

Ipv4NetworkConfigurator StandardHost Router Router Router StandardHost

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

The path to the InterfaceTable module
inlet.bgp.routingTableModule string
inlet.bgp.ospfRoutingModule string parent.hasOspf ? "^.ospf" : ""
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" : ""
outlet.status.initialStatus string "UP"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Source code

network Tunnel
{
    submodules:
        configurator: Ipv4NetworkConfigurator {
            parameters:
                @display("p=100,100;is=s");
        }
        client: StandardHost {
            parameters:
                @display("p=250,100");
        }
        inlet: Router {
            parameters:
                @display("p=400,100");
        }
        router: Router {
            parameters:
                @display("p=550,100");
        }
        outlet: Router {
            parameters:
                @display("p=700,100");
        }
        server: StandardHost {
            parameters:
                @display("p=850,100");
        }
    connections:
        client.ethg++ <--> Eth1G <--> inlet.ethg++;
        inlet.pppg++ <--> {  delay = 1us; datarate = 1Gbps; } <--> router.pppg++;
        router.pppg++ <--> {  delay = 1us; datarate = 1Gbps; } <--> outlet.pppg++;
        outlet.ethg++ <--> Eth1G <--> server.ethg++;
}
File: examples/inet/tunnel/Tunnel.ned

This documentation is released under the Creative Commons license