StandardHost

compound module

A comprehensive model of an IPv4/IPv6 host that provides a complete network stack with configurable application, transport, network, and link layers. It supports multiple network interfaces, protocols, and applications that can be customized through parameters.

<b>See also:</b> ~WirelessHost, ~AdhocHost, ~Router(1,2)

Inheritance diagram

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

Used in compound modules

Name	Type	Description
IPv4LargeLAN	compound module	Several hosts and an Ethernet hub on a switch. One port of the hub connect to a 10Base2 segment.
IPv4MediumLAN	compound module	Several hosts and a router on an Ethernet hub and a switch
IPv4SmallLAN	compound module	Several hosts on a router; part of ~IPv4LargeNet.
OneNetArea	compound module	(no description)
OSPF_Area3	compound module	(no description)
OspfLan	compound module	(no description)
OspfLan	compound module	(no description)
TestArea	compound module	(no description)
TwoNetsArea	compound module	(no description)

Used in

Name	Type	Description
AntennaOrientation	network	(no description)
AODVNetwork	network	AODV network with an external Ethernet-connected host that can receive traffic from the wireless AODV network. The router acts as the gateway between the wireless AODV network and the wired Ethernet network.
AODVNetworkWithEthernet	network	Extended AODV network with an additional Ethernet-connected host that can receive traffic from the wireless AODV network.
ARPTest	network	(no description)
ARPTest	network	(no description)
Backbone	network	(no description)
Basic3	network	(no description)
BasicMobilityShowcase	network	(no description)
ber	network	(no description)
BGP_Topology_1	network	(no description)
BGP_Topology_1a	network	(no description)
BGP_Topology_2	network	(no description)
BGP_Topology_3	network	(no description)
BGP_Topology_4	network	(no description)
BgpNetwork	network	(no description)
BgpNetwork	network	(no description)
BgpNetwork	network	(no description)
BgpNetwork	network	(no description)
BgpNetwork	network	(no description)
BgpNetwork	network	(no description)
bottleneck	network	(no description)
bottleneck	network	(no description)
bottleneck	network	(no description)
BulkTransfer	network	(no description)
Byte_order	network	(no description)
ChannelThroughputMeasurementShowcase	network	(no description)
ChannelUtilizationMeasurementShowcase	network	(no description)
ClientServer	network	(no description)
ClientServer	network	(no description)
ClientServerWithSM	network	(no description)
ClientServerWithSM	network	(no description)
ClockDriftShowcase	network	(no description)
CloudAndHosts	network	(no description)
CloudAndRouters	network	(no description)
CombiningMobilityShowcase	network	(no description)
ConfiguratorA	network	(no description)
ConfiguratorB	network	(no description)
ConfiguratorE	network	(no description)
DataLinkVisualizerEnablingWiredShowcase	network	(no description)
DataLinkVisualizerFilteringShowcase	network	(no description)
DataRateMeasurementShowcase	network	(no description)
DcTcpIncast	network	(no description)
DHCPShutdownReboot	network	(no description)
DiffservNetwork	network	(no description)
DiffservNetwork	network	This network contains a router with an 10Mbps Ethernet interface, and with a 128kbps dialup connection to a server.
DiffservNetwork	network	(no description)
Dplpmtud	network	(no description)
DynamicTest	network	(no description)
DynamicTest	network	(no description)
EigrpTestNetwork	network	(no description)
EigrpTestNetwork	network	(no description)
EigrpTestNetwork	network	(no description)
EigrpTestNetwork	network	(no description)
EigrpTestNetwork	network	(no description)
EigrpTestNetwork	network	(no description)
EigrpTestNetwork	network	(no description)
EigrpTestNetwork	network	(no description)
EigrpTestNetwork	network	(no description)
EndToEndDelayMeasurementShowcase	network	(no description)
ExtClientExample	network	(no description)
ExtPingerExample	network	(no description)
ExtServerExample	network	(no description)
FlatNet	network	(no description)
FramePreemptionShowcase	network	(no description)
InterfaceNetworkType	network	(no description)
InterfaceTableVisualizationAdvancedFeaturesShowcase	network	(no description)
InterfaceTableVisualizationEnablingVisualizationShowcase	network	(no description)
IPv4LargeNet	network	A large Ethernet LAN -- see model description
JitterMeasurementShowcase	network	(no description)
KIDSNw1	network	(no description)
LDPTEST	network	(no description)
LinearNetwork	network	(no description)
ManetSensorNetwork	network	(no description)
MeasurementRelationshipsShowcase	network	(no description)
MixedMultidropNetwork	network	This module contains an ~EthernetSwitch connected to a ~StandardHost and a 10BASE-T1S multidrop link with a configurable number of nodes. The switch port acts as the controller of the multidrop link. The network node type can be configured for all the nodes on the multidrop link.
MixedNetwork	network	TODO Auto-generated network
multi	network	(no description)
MulticastNetwork	network	(no description)
multihomed	network	(no description)
Multihop_EBGP	network	(no description)
multiple_areas2	network	(no description)
NClients	network	(no description)
NClients	network	(no description)
NClients	network	(no description)
NClients2	network	(no description)
Network	network	TODO documentation
Network	network	(no description)
Network	network	A generated network with grid topology.
Network	network	(no description)
Network2	network	(no description)
NetworkPathComplexShowcase	network	(no description)
NetworkPathRIPShowcase	network	(no description)
NetworkPathSimpleShowcase	network	(no description)
NetworkWithCrossTraffic	network	(no description)
oneclienthost	network	(no description)
OSPF_Area_External_Forwarding	network	(no description)
OSPF_AreaTest	network	(no description)
OSPF_Default_Route_Distribution	network	(no description)
OSPF_mininet	network	(no description)
OSPF_Suboptimal	network	(no description)
OspfNetwork	network	(no description)
PacketDropInterfaceNotConnectedShowcase	network	(no description)
PacketDropNoRouteToDestinationShowcase	network	(no description)
PacketDropQueueOverflowShowcase	network	(no description)
PcapRecorderTest	network	(no description)
PcapRecordingShowcase	network	(no description)
Persistent_congestion	network	(no description)
PIM_SM_Network	network	(no description)
pimDMFinal	network	(no description)
PropagationTimeMeasurementShowcase	network	(no description)
QueueingTimeMeasurementShowcase	network	(no description)
QuicLinkSharingShowcase	network	(no description)
R37	network	(no description)
RedMarkerNetwork	network	(no description)
RegressionTestingTutorialWired	network	(no description)
ResidenceTimeMeasurementShowcase	network	(no description)
RipNetworkA	network	(no description)
RipNetworkB	network	(no description)
RipNetworkC	network	(no description)
RouterLSA	network	(no description)
RoutingTableVisualizationDisplayingAllShowcase	network	(no description)
RoutingTableVisualizationFilteringShowcase	network	(no description)
RSVPTE4	network	Example network to demonstrate Rsvp-TE.
RSVPTE4	network	Example network to demonstrate Rsvp-TE.
RSVPTE4	network	Example network to demonstrate Rsvp-TE.
RSVPTE4	network	Example network to demonstrate Rsvp-TE.
RSVPTE4	network	Example network to demonstrate Rsvp-TE.
SensorNetworkShowcaseA	network	(no description)
SensorNetworkShowcaseB	network	(no description)
shared_link	network	(no description)
SimpleConfiguratorNetwork	network	(no description)
SimpleContinentCloud	network	(no description)
SimpleTest	network	(no description)
SimpleTest	network	(no description)
small	network	(no description)
SpatialMobilityShowcase	network	(no description)
TcpAppExample	network	(no description)
tcpwindowscale	network	(no description)
testNetwork	network	(no description)
TimingExample	network	(no description)
Traceroute	network	(no description)
Trafficgen	network	(no description)
TransmissionTimeMeasurementShowcase	network	(no description)
TransportConnectionVisualizationEnablingShowcase	network	(no description)
TransportConnectionVisualizationMultipleConnectionsShowcase	network	(no description)
TransportPathVisualizerFilteringShowcase	network	(no description)
TransportPathVisualizerSimpleWiredShowcase	network	(no description)
Tunnel	network	(no description)
twoclienthosts	network	(no description)
TwoHosts	network	(no description)
UdpAppExample	network	(no description)
UDPBroadcastNetwork	network	(no description)
UDPBurst	network	(no description)
UdpClientServer	network	(no description)
v3_square_2_areas	network	(no description)
VideoStreamingShowcase	network	(no description)
VlanExample	network	(no description)
Voip	network	A generated network with star topology.
VoIPStreamLargeNet	network	This is a copy of the LargeNet(1,2) Ethernet demo simulation in the INET Framework, modified to add a VoIP server and a VoIP client. It can be used to test VoIP transmission on a LAN with high background traffic.
VoIPStreamTest	network	(no description)
VoIPStreamTrafficTest	network	(no description)
WebserverShowcase	network	(no description)
WiredAndWirelessHostsWithAP	network	(no description)
WiredNetWithDHCP	network	(no description)
WirelessNetWith2DHCP	network	(no description)
WirelessNetWithDHCP	network	(no description)
zerortt	network	(no description)

Known subclasses

Name	Type	Description
EthernetPlcaHost	compound module	A network node designed specifically for Ethernet 10BASE-T1S multidrop networks. It extends StandardHost with specialized Ethernet interfaces that support the Physical Layer Collision Avoidance (PLCA) protocol.
EthernetPlcaNode	compound module	This module implements an Ethernet network node that is suitable for use in Ethernet 10BASE-T1S multidrop links. Such a multidrop link uses the Ethernet Phyisical Layer Collision Avoidance (PLCA) protocol. The protocol is defined in the IEEE 802.3cg-2019 standard.
GpsrStandardHost	compound module	(no description)
GptpEndstation	compound module	Implements a gPTP end station that contains a clock module and a gPTP protocol.
MyHost	compound module	(no description)
MyStandardHost	compound module	(no description)
RtpHost	compound module	A network node with Real-time Transport Protocol (RTP) support. Extends StandardHost by adding RTP-specific components for real-time multimedia streaming applications.
SctpNatRouter	compound module	SCTP NAT router
StandardHost6	compound module	An IPv6 host with TCP, UDP, and SCTP transport layer protocols. It extends the standard host model by configuring it to use IPv6 as the network layer protocol while disabling IPv4 by default.
TsnDevice	compound module	An end device with Time-Sensitive Networking (TSN) capabilities. It extends the StandardHost with various TSN features defined in the IEEE 802.1 standards suite for deterministic, low-latency communication over Ethernet networks.
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.

Extends

Name	Type	Description
ApplicationLayerNodeBase	compound module	An extension of the transport layer node base that adds support for applications. Provides the highest level of abstraction for network nodes, completing the full network stack from physical to application layer.

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	0
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	false
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/pc2

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 comprehensive model of an IPv4/IPv6 host that provides a complete network
// stack with configurable application, transport, network, and link layers. It
// supports multiple network interfaces, protocols, and applications that can be
// customized through parameters.
//
// @see ~WirelessHost, ~AdhocHost, ~Router
//
module StandardHost extends ApplicationLayerNodeBase
{
    parameters:
        @display("i=device/pc2");
        @figure[submodules];
        forwarding = default(false);  // Disable routing by default
        ipv4.arp.proxyArpInterfaces = default(""); // Proxy arp is disabled on hosts by default
        *.routingTableModule = default("^.ipv4.routingTable");
}

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