ExtClientServer_bgCells

Package: simu5g.emulation.extclientserver_bgTraffic

ExtClientServer_bgCells

network

ExtClientServer_bgCells

One real UE receives data from a real server The network includes a configurable number of background cells

routingRecorder : RoutingTableRecorder Records changes in the routing tables (~Ipv4RoutingTable) and interface tables (~InterfaceTable) of... Source: routingRecorder: RoutingTableRecorder { @display("p=73,130;is=s"); } configurator : Ipv4NetworkConfigurator This module assigns IPv4 addresses and sets up static routing for an IPv4 network. Source: configurator: Ipv4NetworkConfigurator { @display("p=73,72"); } channelControl : LteChannelControl Utility module that records the position of each LTE radio module in the network. Source: channelControl: LteChannelControl { @display("p=70,190;is=s"); } binder : Binder Binder module Source: binder: Binder { @display("p=73,261;is=s"); } carrierAggregation : CarrierAggregation This module implements the Carrier Aggregation (CA) functionality used at the Medium Access Control... Source: carrierAggregation: CarrierAggregation { @display("p=72,343;is=s"); } router : Router IPv4 router that supports wireless, Ethernet, PPP and external interfaces. Source: router: Router { @display("p=223,175;i=device/smallrouter"); } upf : Upf Implements a 5G Core User Plane Function (UPF) module. Source: upf: Upf { @display("p=460,174"); } gnb : gNodeB This module implements a gNodeB for a 5G LTE network. Source: gnb: gNodeB { @display("p=671,174;is=vl"); } bgCell[numBgCells] : BackgroundCell This module implements a lightweight model for a 4G eNodeB or 5G gNodeB. Source: bgCell[numBgCells]: BackgroundCell { @display("p=670,440;is=vl"); } ue : NRUe This module implements a User Equipment (UE) for a 5G LTE network. Source: ue: NRUe { @display("p=670,309"); }

Usage diagram

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

Parameters

Name Type Default value Description
numBgCells int 0

number of BG cells

Properties

Name Value Description
isNetwork
display i=block/network2;bgb=800,554;bgi=background/pisa

Unassigned submodule parameters

Name Type Default value Description
routingRecorder.enabled 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)
channelControl.coreDebug bool false

debug switch for core framework
channelControl.pMax double 20mW

maximum sending power used for this network (in mW)
channelControl.sat double -110dBm

signal attenuation threshold (in dBm)
channelControl.alpha double 2

path loss coefficient
channelControl.carrierFrequency double 2.4GHz

base carrier frequency of all the channels (in Hz)
channelControl.numChannels int 1

number of radio channels (frequencies)
binder.blerShift int 0
binder.maxDataRatePerRb double 1.16Mbps
binder.printTrafficGeneratorConfig bool false
carrierAggregation.componentCarrier.binderModule string "binder"
carrierAggregation.componentCarrier.carrierFrequency double 2GHz

Carrier Frequency (GHz) -->
carrierAggregation.componentCarrier.numBands int 6

number of bands for this channel
carrierAggregation.componentCarrier.numerologyIndex int 0

numerology index
carrierAggregation.componentCarrier.useTdd bool false
carrierAggregation.componentCarrier.tddNumSymbolsDl int 7
carrierAggregation.componentCarrier.tddNumSymbolsUl int 7
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" : ""
upf.status.initialStatus string "UP"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

determines the text that is written on top of the submodule
upf.nl.forwardServiceRegistration bool true
upf.nl.forwardProtocolRegistration bool true
upf.pppIf.pcapRecorder.verbose bool true

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

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

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

enable dump of frames with hasBitError
upf.pppIf.pcapRecorder.sendingSignalNames string "packetSentToLower"

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

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

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

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

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

flush the pcapFile after each write to ensure that all packets are captured in case of a crash
upf.pppIf.pcapRecorder.displayStringTextFormat string "rec: %n pks"
upf.pppIf.ppp.interfaceTableModule string

The path to the InterfaceTable module
upf.pppIf.ppp.displayStringTextFormat string "rate: %b\nsent: %s, rcvd: %r\nqueue: %q, drop: %d"
upf.pppIf.ppp.sendRawBytes bool false

when true packets are serialized into a sequence of bytes before sending out
upf.pppIf.ppp.mtu int 4470B
upf.pppIf.ppp.stopOperationExtraTime double -1s

extra time after lifecycle stop operation finished
upf.pppIf.ppp.stopOperationTimeout double 2s

timeout value for lifecycle stop operation
upf.udp.interfaceTableModule string

The path to the InterfaceTable module
upf.udp.icmpModule string "^.ipv4.icmp"
upf.udp.icmpv6Module string "^.ipv6.icmpv6"
upf.udp.crcMode string "declared"
upf.udp.defaultMulticastLoop bool true
upf.trafficFlowFilter.binderModule string "binder"
upf.trafficFlowFilter.fastForwarding bool true
upf.gtp_user.binderModule string "binder"
upf.gtp_user.interfaceTableModule string

path to the InterfaceTable module
upf.gtp_user.ipOutInterface string ""

optional: manual specification of outgoing interface for received IP
upf.gtp_user.localPort int 31
upf.gtp_user.tunnelPeerPort int 31
upf.tn.displayStringTextFormat string "processed %p pk (%l)"

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

determines the text that is written on top of the submodule
upf.at.forwardServiceRegistration bool true
upf.at.forwardProtocolRegistration bool true
gnb.interfaceTable.displayAddresses bool false

whether to display IP addresses on links
gnb.mobility.subjectModule string "^"

module path which determines the subject module, the motion of which this mobility model describes, the default value is the parent module
gnb.mobility.coordinateSystemModule string ""

module path of the geographic coordinate system module
gnb.mobility.displayStringTextFormat string "p: %p\nv: %v"

format string for the mobility module's display string text
gnb.mobility.updateDisplayString bool true

enables continuous update of the subject module's position via modifying its display string
gnb.mobility.constraintAreaMinX double -inf m

min x position of the constraint area, unconstrained by default (negative infinity)
gnb.mobility.constraintAreaMinY double -inf m

min y position of the constraint area, unconstrained by default (negative infinity)
gnb.mobility.constraintAreaMinZ double -inf m

min z position of the constraint area, unconstrained by default (negative infinity)
gnb.mobility.constraintAreaMaxX double inf m

max x position of the constraint area, unconstrained by default (positive infinity)
gnb.mobility.constraintAreaMaxY double inf m

max y position of the constraint area, unconstrained by default (positive infinity)
gnb.mobility.constraintAreaMaxZ double inf m

max z position of the constraint area, unconstrained by default (positive infinity)
gnb.mobility.initialX double uniform(this.constraintAreaMinX, this.constraintAreaMaxX)
gnb.mobility.initialY double uniform(this.constraintAreaMinY, this.constraintAreaMaxY)
gnb.mobility.initialZ double nanToZero(uniform(this.constraintAreaMinZ, this.constraintAreaMaxZ))
gnb.mobility.initialLatitude double nan deg
gnb.mobility.initialLongitude double nan deg
gnb.mobility.initialAltitude double 0m
gnb.mobility.initialHeading double 0deg
gnb.mobility.initialElevation double 0deg
gnb.mobility.initialBank double 0deg
gnb.mobility.initFromDisplayString bool true

enables one time initialization from the subject module's display string
gnb.mobility.updateFromDisplayString bool true

enables continuous update from the subject module's display string for dragging and rotating it
gnb.cellInfo.constraintAreaMinX double -1m/0

The minimum X-coordinate of the area constraint, unconstrained by default
gnb.cellInfo.constraintAreaMinY double -1m/0

The minimum Y-coordinate of the area constraint, unconstrained by default
gnb.cellInfo.constraintAreaMaxX double 1m/0

The maximum X-coordinate of the area constraint, unconstrained by default
gnb.cellInfo.constraintAreaMaxY double 1m/0

The maximum Y-coordinate of the area constraint, unconstrained by default
gnb.cellInfo.broadcastMessageInterval double 1s

Interval for sending broadcast messages (used for handover or DAS)
gnb.cellInfo.microCell bool false

Type of eNodeB (MICRO / MACRO) - valid only for eNodeBs
gnb.cellInfo.numRus int 0

Number of Remote Units
gnb.cellInfo.ruRange int 0

Range of Remote Units
gnb.cellInfo.ruStartingAngle double 0deg

Initial angle for remote units (used for graphical representation)
gnb.cellInfo.ruTxPower string "0;"

CSV string specifying the TX power for each remote unit (integer values)
gnb.cellInfo.antennaCws string "1;"

Codewords for each antenna, first position refers to the MACRO
gnb.cellInfo.rbyDl int 12

Number of sub-carriers per RB in DL
gnb.cellInfo.rbyUl int 12

Number of sub-carriers per RB in UL
gnb.cellInfo.rbxDl int 7

Number of OFDM symbols per slot in DL
gnb.cellInfo.rbxUl int 7

Number of OFDM symbols per slot in UL
gnb.cellInfo.rbPilotDl int 3

Number of pilot Resource Elements per RB in DL
gnb.cellInfo.rbPilotUl int 0

Number of pilot Resource Elements per RB in UL
gnb.cellInfo.signalDl int 1

Number of signaling symbols for each Resource Block in DL
gnb.cellInfo.signalUl int 1

Number of signaling symbols for each Resource Block in UL
gnb.cellInfo.numPreferredBands int 1

Number of preferred bands to use (relevant only in PREFERRED mode)
gnb.cellInfo.binderModule string "binder"
gnb.collector.collectorType string

it can be: "eNBStatsCollector, gNBStatsCollector, ueStatsCollector, NRueStatsCollector
gnb.pppIf.pcapRecorder.verbose bool true

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

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

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

enable dump of frames with hasBitError
gnb.pppIf.pcapRecorder.sendingSignalNames string "packetSentToLower"

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

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

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

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

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

flush the pcapFile after each write to ensure that all packets are captured in case of a crash
gnb.pppIf.pcapRecorder.displayStringTextFormat string "rec: %n pks"
gnb.pppIf.ppp.interfaceTableModule string

The path to the InterfaceTable module
gnb.pppIf.ppp.displayStringTextFormat string "rate: %b\nsent: %s, rcvd: %r\nqueue: %q, drop: %d"
gnb.pppIf.ppp.sendRawBytes bool false

when true packets are serialized into a sequence of bytes before sending out
gnb.pppIf.ppp.mtu int 4470B
gnb.pppIf.ppp.stopOperationExtraTime double -1s

extra time after lifecycle stop operation finished
gnb.pppIf.ppp.stopOperationTimeout double 2s

timeout value for lifecycle stop operation
gnb.x2ppp.pcapRecorder.verbose bool true

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

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

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

enable dump of frames with hasBitError
gnb.x2ppp.pcapRecorder.sendingSignalNames string "packetSentToLower"

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

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

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

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

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

flush the pcapFile after each write to ensure that all packets are captured in case of a crash
gnb.x2ppp.pcapRecorder.displayStringTextFormat string "rec: %n pks"
gnb.x2ppp.ppp.interfaceTableModule string

The path to the InterfaceTable module
gnb.x2ppp.ppp.displayStringTextFormat string "rate: %b\nsent: %s, rcvd: %r\nqueue: %q, drop: %d"
gnb.x2ppp.ppp.sendRawBytes bool false

when true packets are serialized into a sequence of bytes before sending out
gnb.x2ppp.ppp.mtu int 4470B
gnb.x2ppp.ppp.stopOperationExtraTime double -1s

extra time after lifecycle stop operation finished
gnb.x2ppp.ppp.stopOperationTimeout double 2s

timeout value for lifecycle stop operation
gnb.pppMEHostIf.pcapRecorder.verbose bool true

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

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

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

enable dump of frames with hasBitError
gnb.pppMEHostIf.pcapRecorder.sendingSignalNames string "packetSentToLower"

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

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

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

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

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

flush the pcapFile after each write to ensure that all packets are captured in case of a crash
gnb.pppMEHostIf.pcapRecorder.displayStringTextFormat string "rec: %n pks"
gnb.pppMEHostIf.ppp.interfaceTableModule string

The path to the InterfaceTable module
gnb.pppMEHostIf.ppp.displayStringTextFormat string "rate: %b\nsent: %s, rcvd: %r\nqueue: %q, drop: %d"
gnb.pppMEHostIf.ppp.sendRawBytes bool false

when true packets are serialized into a sequence of bytes before sending out
gnb.pppMEHostIf.ppp.mtu int 4470B
gnb.pppMEHostIf.ppp.stopOperationExtraTime double -1s

extra time after lifecycle stop operation finished
gnb.pppMEHostIf.ppp.stopOperationTimeout double 2s

timeout value for lifecycle stop operation
gnb.udp.interfaceTableModule string

The path to the InterfaceTable module
gnb.udp.icmpModule string "^.ipv4.icmp"
gnb.udp.icmpv6Module string "^.ipv6.icmpv6"
gnb.udp.crcMode string "declared"
gnb.udp.defaultMulticastLoop bool true
gnb.tcp.crcMode string "declared"
gnb.tcp.advertisedWindow int 14*this.mss

in bytes, corresponds with the maximal receiver buffer capacity (Note: normally, NIC queues should be at least this size)
gnb.tcp.delayedAcksEnabled bool false

delayed ACK algorithm (RFC 1122) enabled/disabled
gnb.tcp.nagleEnabled bool true

Nagle's algorithm (RFC 896) enabled/disabled
gnb.tcp.limitedTransmitEnabled bool false

Limited Transmit algorithm (RFC 3042) enabled/disabled (can be used for TcpReno/TcpTahoe/TcpNewReno/TcpNoCongestionControl)
gnb.tcp.increasedIWEnabled bool false

Increased Initial Window (RFC 3390) enabled/disabled
gnb.tcp.sackSupport bool false

Selective Acknowledgment (RFC 2018, 2883, 3517) support (header option) (SACK will be enabled for a connection if both endpoints support it)
gnb.tcp.windowScalingSupport bool false

Window Scale (RFC 1323) support (header option) (WS will be enabled for a connection if both endpoints support it)
gnb.tcp.windowScalingFactor int -1

Window Scaling Factor to the power of 2. -1 indicates that manual window scaling is turned off.
gnb.tcp.timestampSupport bool false

Timestamps (RFC 1323) support (header option) (TS will be enabled for a connection if both endpoints support it)
gnb.tcp.mss int 536

Maximum Segment Size (RFC 793) (header option)
gnb.tcp.msl int 120s

Maximum Segment Lifetime
gnb.tcp.tcpAlgorithmClass string "TcpReno"

TODO: use the following @enum or similar, but it must allow new values for user defined algorithms (omnetpp-6.1 checks @enum strictly): @enum("TcpVegas", "TcpWestwood", "TcpNewReno", "TcpReno", "TcpTahoe", "TcpNoCongestionControl")
gnb.tcp.useDataNotification bool false

turn the notifications for arrived data on or off
gnb.tcp.dupthresh int 3

used for TcpTahoe, TcpReno and SACK (RFC 3517) DO NOT change unless you really know what you are doing
gnb.tcp.initialSsthresh int 0xFFFFFFFF

initial value for Slow Start threshold used in TahoeRenoFamily. The initial value of ssthresh SHOULD be set arbitrarily high (e.g.,to the size of the largest possible advertised window) Without user interaction there is no limit...
gnb.tcp.stopOperationExtraTime double 0s

extra time after lifecycle stop operation finished
gnb.tcp.stopOperationTimeout double 2s

timeout value for lifecycle stop operation
gnb.tcp.ecnWillingness bool false

true if willing to use ECN
gnb.tcp.dctcpGamma double 0.0625

A fixed estimation gain for calculating dctcp_alpha (RFC 8257 4.2)
gnb.x2App.client.localAddress string ""

comma separated list of addresses
gnb.x2App.client.localPort int 0

port number to listen on
gnb.x2App.client.connectAddress string

server address (may be symbolic)
gnb.x2App.client.connectPort int 5000

port number to connect to
gnb.x2App.client.startTime double 0s

time first session begins
gnb.x2App.client.numRequestsPerSession int 1

number of requests sent per session
gnb.x2App.client.numPacketsToReceive int 0
gnb.x2App.client.requestLength int 1452

length of a request (bytes)
gnb.x2App.client.thinkTime double 0s

time gap between requests
gnb.x2App.client.waitToClose double 0s

time to wait between last message sent and abort
gnb.x2App.client.reconnectInterval double 0s

if connection breaks, waits this much before trying to reconnect
gnb.x2App.client.inboundStreams int 17
gnb.x2App.client.outboundStreams int 1
gnb.x2App.client.echo bool false

echoes received packages when true
gnb.x2App.client.ordered bool true
gnb.x2App.client.queueSize int 0
gnb.x2App.client.prMethod int 0

0=NONE, 1=PR_TTL, 2=PR_RTX, 3=PR_PRIO, 4=PR_STRRST
gnb.x2App.client.prValue double 0

for PR-SCTP
gnb.x2App.client.streamReset bool false
gnb.x2App.client.streamRequestTime double 0s
gnb.x2App.client.streamResetType int 5

NO_RESET=5, RESET_OUTGOING=6, RESET_INCOMING=7, RESET_BOTH=8, SSN_TSN=9
gnb.x2App.client.streamToReset int 0
gnb.x2App.client.stopTime double -1s

time of finishing sending, negative values mean forever
gnb.x2App.client.primaryTime double 0s
gnb.x2App.client.newPrimary string ""
gnb.x2App.client.streamRequestLengths string ""
gnb.x2App.client.streamRequestRatio string ""
gnb.x2App.client.streamPriorities string ""
gnb.x2App.client.finishEndsSimulation bool false
gnb.x2App.client.binderModule string "binder"
gnb.x2App.server.localAddress string ""

comma separated list of addresses
gnb.x2App.server.localPort int 0

port number to listen on
gnb.x2App.server.echo bool false

echoes received packages when true
gnb.x2App.server.echoDelay double 0s
gnb.x2App.server.delayFirstRead double 0s
gnb.x2App.server.readingInterval double 0s
gnb.x2App.server.messagesToPush int 0
gnb.x2App.server.numPacketsToSendPerClient int 0

number of requests sent per session
gnb.x2App.server.numPacketsToReceivePerClient int 1
gnb.x2App.server.requestLength int 1452

length of a request (bytes)
gnb.x2App.server.thinkTime double 0s

time gap between requests
gnb.x2App.server.waitToClose double 0s

time to wait between last message sent and abort
gnb.x2App.server.finishEndsSimulation bool false
gnb.x2App.server.ordered bool true
gnb.x2App.server.inboundStreams int 17
gnb.x2App.server.outboundStreams int 1
gnb.x2App.server.queueSize int 0
gnb.x2App.server.prMethod int 0

0=NONE, 1=PR_TTL, 2=PR_RTX, 3=PR_PRIO, 4=PR_STRRST
gnb.x2App.server.prValue double 0

for PR-SCTP
gnb.x2App.server.streamReset bool false
gnb.x2App.server.streamRequestTime double 0s
gnb.x2App.server.streamToReset int 0
gnb.x2App.server.streamPriorities string ""
gnb.x2App.server.binderModule string "binder"
gnb.sctp.interfaceTableModule string
gnb.sctp.routingTableModule string
gnb.sctp.crcMode string "declared"
gnb.sctp.numGapReports int 3
gnb.sctp.rtoInitial double 3s
gnb.sctp.rtoMin double 1s
gnb.sctp.rtoMax double 60s
gnb.sctp.rtoAlpha double 0.125
gnb.sctp.rtoBeta double 0.250
gnb.sctp.maxBurst int 4
gnb.sctp.maxBurstVariant string "maxBurst"
gnb.sctp.initialWindow int 0
gnb.sctp.assocMaxRetrans int 10
gnb.sctp.pathMaxRetrans int 5
gnb.sctp.maxInitRetrans int 8
gnb.sctp.sackPeriod double 200ms
gnb.sctp.sackFrequency int 2
gnb.sctp.reactivatePrimaryPath bool false
gnb.sctp.sendQueueLimit int 0
gnb.sctp.validCookieLifetime double 10s
gnb.sctp.enableHeartbeats bool true
gnb.sctp.hbInterval double 30s
gnb.sctp.sendHeartbeatsOnActivePaths bool false
gnb.sctp.nagleEnabled bool true
gnb.sctp.naglePoint int 1468
gnb.sctp.fragPoint int 1452
gnb.sctp.fastRecoverySupported bool true
gnb.sctp.sctpAlgorithmClass string "SctpAlg"
gnb.sctp.ccModule int 0

RFC4960=0
gnb.sctp.osbWithHeader bool false
gnb.sctp.RTXMethod int 0

0=Once after 3 Sacks; 1=once per RTT; 2=Switch off Fast Retransmit; 3=Always after 3 Sacks
gnb.sctp.ssModule int 0
gnb.sctp.arwnd int 65535
gnb.sctp.swsLimit int 3000

Limit for SWS
gnb.sctp.udpEncapsEnabled bool false
gnb.sctp.natFriendly bool false
gnb.sctp.bytesToAddPerRcvdChunk int 0

for flowcontrol
gnb.sctp.bytesToAddPerPeerChunk int 0

for flowcontrol
gnb.sctp.tellArwnd bool false

for flowcontrol
gnb.sctp.messageAcceptLimit int 0

for flowcontrol
gnb.sctp.fairStart double 0s
gnb.sctp.fairStop double 0s
gnb.sctp.streamsToPaths string ""
gnb.sctp.startEndToEndDelay int 0
gnb.sctp.stopEndToEndDelay int 10
gnb.sctp.throughputInterval double 1
gnb.sctp.auth bool false
gnb.sctp.chunks string ""
gnb.sctp.padding bool false
gnb.sctp.addIP bool false
gnb.sctp.addTime double 0s
gnb.sctp.addAddress string ""
gnb.sctp.addIpType string "0"

SET_PRIMARY_ADDRESS=49156,ADD_IP_ADDRESS=49153,DELETE_IP_ADDRESS=49154
gnb.sctp.packetDrop bool false
gnb.sctp.sackNow bool false
gnb.sctp.highSpeedCC bool false
gnb.sctp.checkSackSeqNumber bool false
gnb.sctp.nrSack bool false
gnb.sctp.disableReneging bool false
gnb.sctp.gapReportLimit int 100000000
gnb.sctp.gapListOptimizationVariant string "none"
gnb.sctp.smartOverfullSACKHandling bool false
gnb.sctp.allowQoSTracking bool false
gnb.sctp.qosTrackingInterval double 1.0s
gnb.sctp.cmtSendAllVariant string "normal"
gnb.sctp.cmtRetransmissionVariant string "normal"
gnb.sctp.cmtCUCVariant string "normal"
gnb.sctp.cmtBufferSplitVariant string "none"
gnb.sctp.cmtBufferSplittingUsesOSB bool false
gnb.sctp.cmtUseSFR bool true
gnb.sctp.cmtUseDAC bool true
gnb.sctp.cmtUseFRC bool true
gnb.sctp.cmtSmartT3Reset bool true
gnb.sctp.cmtSmartFastRTX bool true
gnb.sctp.cmtSmartReneging bool false
gnb.sctp.cmtSlowPathRTTUpdate bool false
gnb.sctp.cmtChunkReschedulingVariant string "none"
gnb.sctp.cmtChunkReschedulingThreshold double 0.5
gnb.sctp.cmtMovedChunksReduceCwnd bool true
gnb.sctp.movedChunkFastRTXFactor double 2.0
gnb.sctp.cmtSackPath string "standard"
gnb.sctp.strictCwndBooking bool false
gnb.sctp.cmtCCVariant string "off"

CMT Congestion Control Variant off = use over every path the default RFC4960 CC (New Reno) lia = First resource pooling congestion control RFC6356 adapted for SCTP - https://datatracker.ietf.org/doc/rfc6356/ olia = alternative MPTCP CC, adapted for SCTP- https://tools.ietf.org/html/draft-khalili-mptcp-congestion-control-05 cmtrpv1 = First resource pooling based CC for SCTP - https://www.tdr.wiwi.uni-due.de/fileadmin/fileupload/I-TDR/SCTP/Paper/AINA2010.pdf cmtrpv2 = Updated version of cmtrpv1 - https://www.tdr.wiwi.uni-due.de/fileadmin/fileupload/I-TDR/SCTP/Paper/ConTEL2011.pdf
gnb.sctp.cmtCCPathGroups string ""
gnb.sctp.rpPathBlocking bool false
gnb.sctp.rpScaleBlockingTimeout bool false
gnb.sctp.rpMinCwnd int 1
gnb.at.displayStringTextFormat string "processed %p pk (%l)"

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

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

determines the text that is written on top of the submodule
gnb.nl.forwardServiceRegistration bool true
gnb.nl.forwardProtocolRegistration bool true
gnb.trafficFlowFilter.binderModule string "binder"
gnb.trafficFlowFilter.fastForwarding bool true
gnb.gtpUser.binderModule string "binder"
gnb.gtpUser.interfaceTableModule string

path to the InterfaceTable module
gnb.gtpUser.localPort int 31
gnb.gtpUser.tunnelPeerPort int 31
gnb.gtpUserX2.binderModule string "binder"
gnb.gtpUserX2.localPort int 32
gnb.gtpUserX2.tunnelPeerPort int 32
bgCell.mobility.subjectModule string "^"

module path which determines the subject module, the motion of which this mobility model describes, the default value is the parent module
bgCell.mobility.coordinateSystemModule string ""

module path of the geographic coordinate system module
bgCell.mobility.displayStringTextFormat string "p: %p\nv: %v"

format string for the mobility module's display string text
bgCell.mobility.updateDisplayString bool true

enables continuous update of the subject module's position via modifying its display string
bgCell.mobility.constraintAreaMinX double -inf m

min x position of the constraint area, unconstrained by default (negative infinity)
bgCell.mobility.constraintAreaMinY double -inf m

min y position of the constraint area, unconstrained by default (negative infinity)
bgCell.mobility.constraintAreaMinZ double -inf m

min z position of the constraint area, unconstrained by default (negative infinity)
bgCell.mobility.constraintAreaMaxX double inf m

max x position of the constraint area, unconstrained by default (positive infinity)
bgCell.mobility.constraintAreaMaxY double inf m

max y position of the constraint area, unconstrained by default (positive infinity)
bgCell.mobility.constraintAreaMaxZ double inf m

max z position of the constraint area, unconstrained by default (positive infinity)
bgCell.mobility.initialX double uniform(this.constraintAreaMinX, this.constraintAreaMaxX)
bgCell.mobility.initialY double uniform(this.constraintAreaMinY, this.constraintAreaMaxY)
bgCell.mobility.initialZ double nanToZero(uniform(this.constraintAreaMinZ, this.constraintAreaMaxZ))
bgCell.mobility.initialLatitude double nan deg
bgCell.mobility.initialLongitude double nan deg
bgCell.mobility.initialAltitude double 0m
bgCell.mobility.initialHeading double 0deg
bgCell.mobility.initialElevation double 0deg
bgCell.mobility.initialBank double 0deg
bgCell.mobility.initFromDisplayString bool true

enables one time initialization from the subject module's display string
bgCell.mobility.updateFromDisplayString bool true

enables continuous update from the subject module's display string for dragging and rotating it
bgCell.bgChannelModel.binderModule string "binder"

modules
bgCell.bgChannelModel.shadowing bool true

Enable/disable shadowing
bgCell.bgChannelModel.scenario string "URBAN_MACROCELL"

Pathloss scenario from ITU -->
bgCell.bgChannelModel.nodeb_height double 25m

eNodeB height -->
bgCell.bgChannelModel.building_height double 20m

Building height -->
bgCell.bgChannelModel.inside_building bool false

determines if the UE is inside a building
bgCell.bgChannelModel.street_wide double 20m

TODO width
bgCell.bgChannelModel.ue_height double 1.5m
bgCell.bgChannelModel.tolerateMaxDistViolation bool false
bgCell.bgChannelModel.correlation_distance double 50m
bgCell.bgChannelModel.antennaGainUe double 0dBi

Antenna Gain of UE --> wrt an isotropic antenna
bgCell.bgChannelModel.antennGainEnB double 18dBi

Antenna Gain of eNodeB -->
bgCell.bgChannelModel.antennGainMicro double 5dBi

Antenna Gain of Micro node -->
bgCell.bgChannelModel.thermalNoise double -104.5dBm

Thermal Noise for 10 MHz of Bandwidth -->
bgCell.bgChannelModel.ue_noise_figure double 7dBm

Ue noise figure -->
bgCell.bgChannelModel.bs_noise_figure double 5dBm

eNodeB noise figure -->
bgCell.bgChannelModel.cable_loss double 2dB

Cable Loss -->
bgCell.bgChannelModel.dynamic_los bool false

If true enable the possibility to switch dinamically the LOS/NLOS pathloss computation -->
bgCell.bgChannelModel.fixed_los bool false

If dynamic-los is false this parameter, if true, compute LOS pathloss otherwise compute NLOS pathloss -->
bgCell.bgChannelModel.fading bool true

Enable/disable fading -->
bgCell.bgChannelModel.fading_type string "JAKES"

Fading type (JAKES or RAYLEIGH) -->
bgCell.bgChannelModel.fading_paths int 6

If jakes fading this parameter specify the number of path (tap channel) -->
bgCell.bgChannelModel.delay_rms double 363ns
bgCell.bgChannelModel.bgCell_interference bool true

if true, enables the inter-cell interference computation for UL and DL connections from background cells -->
bgCell.bgChannelModel.downlink_interference bool true

if true, enables the inter-cell interference computation for DL connections -->
bgCell.bgChannelModel.uplink_interference bool true

if true, enables the interference computation for UL connections -->
bgCell.bgScheduler.binderModule string "binder"
bgCell.bgScheduler.channelModelModule string "^.bgChannelModel"
bgCell.bgScheduler.txPower double 46dBm

transmission power
bgCell.bgScheduler.txDirection string "OMNI"

transmission direction
bgCell.bgScheduler.txAngle double 0deg

transmission angle
bgCell.bgScheduler.isNr bool false

flag to indicate whether this is a NR base station
bgCell.bgScheduler.numerologyIndex int 0

operating carrier
bgCell.bgScheduler.carrierFrequency double 2GHz

operating carrier
bgCell.bgScheduler.numBands int 6

carrier bandwidth
ue.interfaceTable.displayAddresses bool false

whether to display IP addresses on links
ue.eth.bitrate double
ue.at.displayStringTextFormat string "processed %p pk (%l)"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Source code

// ExtClientServer_bgCells
//
// One real UE receives data from a real server
// The network includes a configurable number of background cells
//
network ExtClientServer_bgCells
{
    parameters:
        @display("i=block/network2;bgb=800,554;bgi=background/pisa");

        // number of BG cells
        int numBgCells = default(0);

    submodules:
        routingRecorder: RoutingTableRecorder {
            @display("p=73,130;is=s");
        }
        configurator: Ipv4NetworkConfigurator {
            @display("p=73,72");
        }
        channelControl: LteChannelControl {
            @display("p=70,190;is=s");
        }
        binder: Binder {
            @display("p=73,261;is=s");
        }
        carrierAggregation: CarrierAggregation {
            @display("p=72,343;is=s");
        }
        router: Router {
            @display("p=223,175;i=device/smallrouter");
        }
        upf: Upf {
            @display("p=460,174");
        }
        gnb: gNodeB {
            @display("p=671,174;is=vl");
        }
        bgCell[numBgCells]: BackgroundCell {
            @display("p=670,440;is=vl");
        }
        ue: NRUe {
            @display("p=670,309");
        }

    connections allowunconnected:
        router.pppg++ <--> Eth10G <--> upf.filterGate;
        upf.pppg++ <--> Eth10G <--> gnb.ppp;
}
File: emulation/extclientserver_bgTraffic/ExtClientServer_bgCells.ned

This documentation is released under the Creative Commons license