AdhocHost

compound module

A mobile wireless node that participates in ad hoc networks without centralized infrastructure. Extends WirelessHost by configuring the wireless interface for ad hoc mode operation and enabling packet forwarding.

In ad hoc mode, nodes communicate directly with each other without requiring an access point. This model is suitable for simulating mobile ad hoc networks (MANETs), wireless mesh networks, and other decentralized wireless scenarios.

Inheritance diagram

The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.

Used in

Name	Type	Description
AggregationShowcase	network	(no description)
AnalogModelShowcaseDistanceNetwork	network	(no description)
AnalogModelShowcaseNoiseNetwork	network	(no description)
AntennaDirectionalSelectivityExample	network	(no description)
BabelShowcase	network	(no description)
BlockAckShowcase	network	(no description)
CoexistenceShowcase	network	(no description)
CommunicationCacheExample	network	(no description)
ComplexConfiguratorNetwork	network	(no description)
CorruptionModeExample	network	(no description)
Crosstalk	network	(no description)
CrosstalkShowcaseBaseNetwork	network	(no description)
DataLinkVisualizerActivityLevelShowcase	network	(no description)
DataLinkVisualizerEnablingWirelessShowcase	network	(no description)
DirectionalAntennasShowcase	network	(no description)
DynamicRadioNetwork	network	(no description)
EarthVisualization3	network	(no description)
ErrorRateShowcase	network	(no description)
ErrorRateTest	network	(no description)
FragmentationShowcase	network	(no description)
Ieee80211LevelofDetailShowcase	network	(no description)
InstrumentShowcase	network	(no description)
InterfaceTableVisualizationAdvancedFeaturesShowcase	network	(no description)
Layered80211	network	(no description)
LayeredApsk	network	(no description)
MacTest	network	(no description)
MediumActivityInterferingSignalsShowcase	network	(no description)
MediumActivityMultipleNodesShowcase	network	(no description)
MobilityVisualizerShowcase	network	(no description)
Net	network	(no description)
Net80211	network	(no description)
NetworkNodeVisualizerShowcase	network	(no description)
ObjectCacheTest	network	(no description)
ObstacleIntersectionTest	network	(no description)
ObstacleTest	network	(no description)
PacketDropArpResolutionFailedShowcase	network	(no description)
PacketDropMacRetryLimitReachedShowcase	network	(no description)
PathLossShowcase	network	(no description)
PcapRecordingShowcase	network	(no description)
PhysicalLinkVisualizerEnablingShowcase	network	(no description)
PhysicalLinkVisualizerMobileShowcase	network	(no description)
PowerConsumptionShowcase	network	(no description)
PowerNetwork	network	(no description)
QosThroughput	network	(no description)
RegressionTestingTutorialWireless	network	(no description)
Scenario	network	(no description)
SpectrumShowcasePowerDensityMapNetwork	network	(no description)
SpectrumShowcaseSpectrumFigureSpectrogramNetwork	network	(no description)
StatisticVisualizationPacketErrorRateShowcase	network	(no description)
StatisticVisualizationPingRttShowcase	network	(no description)
StylingShowcase	network	(no description)
SubmoduleInformationVisualizationShowcase	network	(no description)
Synchronized	network	(no description)
TransportPathVisualizerSimpleWirelessShowcase	network	(no description)
TxopShowcase	network	(no description)

Known subclasses

Name	Type	Description
AodvRouter	compound module	A mobile node with the Ad hoc On-Demand Distance Vector (AODV) routing protocol. Extends AdhocHost by adding the AODV routing protocol module.
DsdvRouter	compound module	A mobile node with the Destination-Sequenced Distance Vector (DSDV) routing protocol. Extends AdhocHost by adding the DSDV routing protocol module.
DymoRouter	compound module	A mobile node with the Dynamic MANET On-demand (DYMO) routing protocol. Extends AdhocHost by adding the DYMO routing protocol module.
GpsrRouter	compound module	A mobile node with the Greedy Perimeter Stateless Routing (GPSR) protocol. It extends AdhocHost by adding the GPSR routing protocol module.
ManetRouter	compound module	A mobile node with ad hoc routing capabilities intended for Mobile Ad hoc Networks (MANETs). Extends AdhocHost by adding support for MANET routing protocols.

Extends

Name	Type	Description
WirelessHost	compound module	A mobile device with wireless connectivity operating in infrastructure mode. Extends StandardHost by adding a preconfigured IEEE 802.11 wireless interface, making it suitable for simulating devices in WiFi networks.

Parameters

Name	Type	Default value	Description
displayStringTextFormat	string	""	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
hasStatus	bool	false
hasEnvironment	bool	false
osgModel	string	""	3D model for OSG visualization, no 3D model by default
osgModelColor	string	""	Tint color, no colorization by default
canvasImage	string	""	Image for canvas visualization, no image by default
canvasImageColor	string	""	Tint color, no colorization by default
recordPcap	bool	false
numPcapRecorders	int	recordPcap ? 1 : 0
numLoInterfaces	int	1
numWlanInterfaces	int	1
numEthInterfaces	int	0	Minimum number of Ethernet interfaces
numPppInterfaces	int	0	Minimum number of PPP interfaces
numTunInterfaces	int	0
numVirtInterfaces	int	0
fcsMode	string	"declared"
hasIpv4	bool	true
hasIpv6	bool	false
hasGn	bool	false
forwarding	bool	true
multicastForwarding	bool	false
hasUdp	bool	firstAvailableOrEmpty("Udp") != ""
hasTcp	bool	firstAvailableOrEmpty("Tcp", "TcpLwip", "TcpNsc") != ""
hasSctp	bool	false
hasQuic	bool	false
numApps	int	0

Properties

Name	Value	Description
class	NodeBase
networkNode
labels	node
display	i=device/cellphone

Gates

Name	Direction	Size
radioIn [ ]	input	numWlanInterfaces
pppg [ ]	inout	numPppInterfaces
ethg [ ]	inout	numEthInterfaces

Unassigned submodule parameters

Name	Type	Default value	Description
status.displayStringTextFormat	string	""	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
status.initialStatus	string	"UP"	TODO @signal, @statistic
environment.displayStringTextFormat	string	""	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
environment.initStage	int	0	Initialization stage for the setup command
environment.globalNamespace	bool	false	Create new network namespaces under /var/run/netns/ (Linux only)
environment.namespace	string	""	Name of the host OS network namespace (optional) (Linux only)
environment.setupCommand	string	""	A host OS system command
environment.teardownCommand	string	""	A host OS system command
pcapRecorder.displayStringTextFormat	string	"rec: %n pks"	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
pcapRecorder.verbose	bool	true	Whether to log packets on the module output
pcapRecorder.recordEmptyPackets	bool	true	Specifies if zero length packets are recorded or not
pcapRecorder.enableConvertingPackets	bool	true	Specifies if converting packets to link type is allowed or not
pcapRecorder.pcapFile	string	""	The PCAP file to be written, suggested value: pcapFile = "${resultdir}/${configname}-#${runnumber}" + fullpath() + ".pcap"
pcapRecorder.fileFormat	string	"pcapng"
pcapRecorder.snaplen	int	65535	Maximum number of bytes to record per packet
pcapRecorder.timePrecision	int	6	Time precision in recorded file. pcap supports only 6 (usec) or 9 (nanosec), pcapng supports more values (see 'if_tsresol' option in pcapng file format).
pcapRecorder.dumpBadFrames	bool	true	Enable dump of frames with hasBitError
pcapRecorder.moduleNamePatterns	string	"wlan[] eth[] ppp[*]"	Space-separated list of sibling module names to listen on
pcapRecorder.sendingSignalNames	string	"transmissionEnded"	Space-separated list of outbound packet signals to subscribe to
pcapRecorder.receivingSignalNames	string	"receptionEnded"	Space-separated list of inbound packet signals to subscribe to
pcapRecorder.dumpProtocols	string	"ethernetmac ppp ieee80211mac"	Space-separated list of protocol names as defined in the Protocol class
pcapRecorder.packetFilter	object	"*"	Which packets are considered, matches all packets by default
pcapRecorder.helpers	string	""	Usable PcapRecorder::IHelper helpers for accept packettype and store/convert packet as specified linktype currently available: "inet::AckingMacToEthernetPcapRecorderHelper"
pcapRecorder.alwaysFlush	bool	false	Flush the pcapFile after each write to ensure that all packets are captured in case of a crash
interfaceTable.displayStringTextFormat	string	""	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
interfaceTable.displayAddresses	bool	false	Whether to display IP addresses on links
cb.displayStringTextFormat	string	"processed %p pk (%l)"	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
cb.interfaceTableModule	string		Module path to the ~InterfaceTable module
cb.forwardServiceRegistration	bool	true
cb.forwardProtocolRegistration	bool	true
cb.interfaceMapping	object	{}	Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
cb.serviceMapping	object	{}	Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
cb.protocolMapping	object	{}	Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
bl.displayStringTextFormat	string	"processed %p pk (%l)"	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
bl.interfaceTableModule	string		Module path to the ~InterfaceTable module
bl.forwardServiceRegistration	bool	true
bl.forwardProtocolRegistration	bool	true
bl.interfaceMapping	object	{}	Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
bl.serviceMapping	object	{}	Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
bl.protocolMapping	object	{}	Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
li.displayStringTextFormat	string	"processed %p pk (%l)"	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
li.interfaceTableModule	string		Module path to the ~InterfaceTable module
li.forwardServiceRegistration	bool	true
li.forwardProtocolRegistration	bool	true
li.interfaceMapping	object	{}	Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
li.serviceMapping	object	{}	Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
li.protocolMapping	object	{}	Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
eth.bitrate	double
nl.displayStringTextFormat	string	"processed %p pk (%l)"	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
nl.interfaceTableModule	string		Module path to the ~InterfaceTable module
nl.forwardServiceRegistration	bool	true
nl.forwardProtocolRegistration	bool	true
nl.interfaceMapping	object	{}	Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
nl.serviceMapping	object	{}	Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
nl.protocolMapping	object	{}	Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
tn.displayStringTextFormat	string	"processed %p pk (%l)"	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
tn.interfaceTableModule	string		Module path to the ~InterfaceTable module
tn.forwardServiceRegistration	bool	true
tn.forwardProtocolRegistration	bool	true
tn.interfaceMapping	object	{}	Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
tn.serviceMapping	object	{}	Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
tn.protocolMapping	object	{}	Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
at.displayStringTextFormat	string	"processed %p pk (%l)"	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
at.interfaceTableModule	string		Module path to the ~InterfaceTable module
at.forwardServiceRegistration	bool	true
at.forwardProtocolRegistration	bool	true
at.interfaceMapping	object	{}	Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
at.serviceMapping	object	{}	Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
at.protocolMapping	object	{}	Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default

Source code

//
// A mobile wireless node that participates in ad hoc networks without
// centralized infrastructure. Extends WirelessHost by configuring the wireless interface
// for ad hoc mode operation and enabling packet forwarding.
//
// In ad hoc mode, nodes communicate directly with each other without requiring an access point.
// This model is suitable for simulating mobile ad hoc networks (MANETs), wireless mesh networks,
// and other decentralized wireless scenarios.
//
module AdhocHost extends WirelessHost
{
    parameters:
        @display("i=device/cellphone");
        wlan[*].mgmt.typename = default("Ieee80211MgmtAdhoc");
        wlan[*].agent.typename = default("");
        forwarding = default(true);
}

File: src/inet/node/inet/AdhocHost.ned