HiddenNodeShowcase

Package: inet.showcases.wireless.hiddennode

HiddenNodeShowcase

network

(no description)

WirelessHost WirelessHost WirelessHost UnitDiskRadioMedium Ipv4NetworkConfigurator IntegratedCanvasVisualizer PhysicalEnvironment

Usage diagram

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

Properties

Name Value Description
isNetwork
display b=297,203;bgb=736.6,557.784

Statistics

Name Title Source Record Unit Interpolation Mode
packetReceived hostB.udp.packetReceived figure(count)

Unassigned submodule parameters

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

determines the text that is written on top of the submodule
hostC.at.forwardServiceRegistration bool true
hostC.at.forwardProtocolRegistration bool true
radioMedium.neighborCache.refillPeriod double
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 HiddenNodeShowcase
{
    parameters:
        @display("b=297,203;bgb=736.6,557.784");
        @figure[rcvdPkText](type=indicatorText; pos=420,20; anchor=w; font=,20; textFormat="packets received: %g"; initialValue=0);
        @statistic[packetReceived](source=hostB.udp.packetReceived; record=figure(count); targetFigure=rcvdPkText);
    submodules:

        hostA: WirelessHost {
            @display("p=300,272");
        }
        hostB: WirelessHost {
            @display("p=450,100");
        }
        hostC: WirelessHost {
            @display("p=600,272");
        }
        radioMedium: UnitDiskRadioMedium {
            @display("p=100,100");
        }
        configurator: Ipv4NetworkConfigurator {
            @display("p=100,200");
        }
        visualizer: IntegratedCanvasVisualizer {
            @display("p=100,300");
        }
        physicalEnvironment: PhysicalEnvironment {
            @display("p=100,400");
        }
}
File: showcases/wireless/hiddennode/HiddenNodeShowcase.ned

This documentation is released under the Creative Commons license