PcapRecordingShowcase

Package: inet.showcases.general.pcaprecording

PcapRecordingShowcase

network

(no description)

Ipv4NetworkConfigurator IntegratedMultiVisualizer Ieee80211ScalarRadioMedium AdhocHost AdhocHost StandardHost StandardHost Router Router

Usage diagram

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

Properties

Name Value Description
isNetwork
display bgb=1214,400

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)
radioMedium.neighborCache.refillPeriod double
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
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
ethHost1.status.initialStatus string "UP"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

The path to the InterfaceTable module
router2.bgp.routingTableModule string
router2.bgp.ospfRoutingModule string parent.hasOspf ? "^.ospf" : ""

Source code

network PcapRecordingShowcase
{
    @display("bgb=1214,400");
    submodules:
        configurator: Ipv4NetworkConfigurator {
            @display("p=87,57");
        }
        visualizer: IntegratedMultiVisualizer {
            @display("p=87,130");
        }
        radioMedium: Ieee80211ScalarRadioMedium {
            @display("p=86,192");
        }
        host1: AdhocHost {
            @display("p=201,243");
        }
        host2: AdhocHost {
            @display("p=289,115");
        }
        ethHost1: StandardHost {
            @display("p=405,176");
        }
        ethHost2: StandardHost {
            @display("p=1126,176");
        }
        router1: Router {
            @display("p=674,176");
        }
        router2: Router {
            @display("p=891,176");
        }
    connections:
        ethHost1.ethg++ <--> Eth100M <--> router1.ethg++;
        router2.ethg++ <--> Eth100M <--> ethHost2.ethg++;
        router1.pppg++ <--> Eth100M <--> router2.pppg++;
}
File: showcases/general/pcaprecording/PcapRecordingShowcase.ned

This documentation is released under the Creative Commons license