StandardHost

Package: inet.node.inet

StandardHost

compound module

IPv4 host with SCTP, TCP, UDP layers and applications. IP forwarding is disabled by default (see forwarding).

  • Can be connected via ethernet interface to other nodes using the ethg gate. By default full-duplex connections are supported only (twisted pair). Set **.eth[*].typename="EthernetInterface" for a full/half-duplex CSMA/CD implementation (coaxial cable(1,2))
  • By default contains no wireless cards, however it can be configured by the numWlanInterfaces parameter. Wireless card type is configured by the **.wlan[*].typename parameter. see: inet.linklayer.ieee80211 or other modules implementing ~IWirelessInterface
  • Also external interfaces can be configured for HW in the loop simulation using the numEthInterfaces parameter and setting the interface type using **.eth[*].typename in the INI file. see: ~ExtInterface derived modules and ~IExternalInterface
  • If wireless card is present, node mobility can be set using *.*.mobility.typename see: inet.mobility and ~IMobility
NodeStatus IClock IEnergyStorage IEnergyManagement IEnergyGenerator IMobility IMeasurer PcapRecorder InterfaceTable IIeee8022Llc MessageDispatcher IProtocolLayer MessageDispatcher IEthernetLayer IIeee8021qLayer IIeee8021rLayer MessageDispatcher ILoopbackInterface IWirelessInterface IPppInterface IEthernetInterface ITunnelInterface IVirtualInterface INetworkLayer INetworkLayer INetworkLayer MessageDispatcher IUdp ITcp ISctp MessageDispatcher IApp MessageDispatcher

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)
TestArea compound module (no description)
TwoNetsArea compound module (no description)

Used in

Name Type Description
AntennaOrientation network (no description)
ARPTest network (no description)
ARPTest network (no description)
Backbone network (no description)
ber 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)
BulkTransfer network (no description)
ChannelThroughputMeasurementShowcase network (no description)
ChannelUtilizationMeasurementShowcase 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)
Complexer 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)
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)
FlatNet network (no description)
FramePreemptionShowcase 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)
ManetSensorNetwork network (no description)
MeasurementRelationshipsShowcase network (no description)
MixedNetwork network

TODO Auto-generated network
MobilityShowcase network (no description)
MobilityShowcase network (no description)
MobilityShowcase network (no description)
multi network (no description)
MulticastNetwork network (no description)
multihomed 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.
NetworkPathComplexShowcase network (no description)
NetworkPathRIPShowcase network (no description)
NetworkPathSimpleShowcase network (no description)
NetworkWithCrossTraffic network (no description)
OSPF_mininet network (no description)
PacketDropInterfaceNotConnectedShowcase network (no description)
PacketDropNoRouteToDestinationShowcase network (no description)
PacketDropQueueOverflowShowcase network (no description)
PcapRecorderTest network (no description)
PcapRecordingShowcase network (no description)
PIM_SM_Network network (no description)
pimDMFinal network (no description)
PropagationTimeMeasurementShowcase network (no description)
QueueingTimeMeasurementShowcase network (no description)
R37 network (no description)
RedMarkerNetwork network (no description)
RegressionTestingTutorialWired network (no description)
ResidenceTimeMeasurementShowcase 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)
SimpleConfiguratorNetwork network (no description)
SimpleContinentCloud network (no description)
SimpleTest network (no description)
SimpleTest network (no description)
small network (no description)
TcpAppExample network (no description)
tcpwindowscale network (no description)
testNetwork network (no description)
TimingExample 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)
UdpAppExample network (no description)
UDPBroadcastNetwork network (no description)
UDPBurst network (no description)
UdpClientServer network (no description)
v3_square_2_areas network (no description)
VlanExample network (no description)
Voip network

A generated network with star topology.
WiredAndWirelessHostsWithAP network (no description)
WiredNetWithDHCP network (no description)
WirelessNetWith2DHCP network (no description)
WirelessNetWithDHCP network (no description)

Known subclasses

Name Type Description
GptpEndstation compound module

This 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 (no description)
SctpNatRouter compound module

SCTP NAT router
StandardHost6 compound module

IPv6 host with TCP, SCTP and UDP layers and applications. see ~StandardHost for configuration.
TsnDevice compound module

This module represents a Time-Sensitive Networking (TSN) hardware end device that supports time synchronization, per-stream filtering and policing, scheduling and traffic shaping, frame replication and elimination, frame preemption for Ethernet networks. All TSN features are optional and they can be combined with other Ethernet features.
WirelessHost compound module

Models a host with (default) one wireless (802.11) card in infrastructure mode. This module is basically a ~StandardHost with an ~Ieee80211Interface with mgmt.typename = ~Ieee80211MgmtSta added. It should be used in conjunction with ~AccessPoint, or any other AP model which contains ~Ieee80211Interface with mgmt.typename = ~Ieee80211MgmtAp.

Extends

Name Type Description
ApplicationLayerNodeBase compound module (no description)

Parameters

Name Type Default value Description
hasStatus 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
numApps int 0

Properties

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

Gates

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

Unassigned submodule parameters

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

TODO @signal, @statistic
pcapRecorder.verbose bool true

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

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

maximum number of bytes to record per packet
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 "packetSentToLower"

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

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
pcapRecorder.displayStringTextFormat string "rec: %n pks"
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
cb.forwardServiceRegistration bool true
cb.forwardProtocolRegistration bool true
bl.displayStringTextFormat string "processed %p pk (%l)"

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

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

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

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

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

Source code

//
// IPv4 host with SCTP, TCP, UDP layers and applications.
// IP forwarding is disabled by default (see forwarding).
// - Can be connected via ethernet interface to other nodes using
//   the ethg gate. By default full-duplex connections are supported
//   only (twisted pair). Set **.eth[*].typename="EthernetInterface" for
//   a full/half-duplex CSMA/CD implementation (coaxial cable)
// - By default contains no wireless cards, however it can be configured
//   by the numWlanInterfaces parameter. Wireless card type is configured by the
//   **.wlan[*].typename parameter. see:  inet.linklayer.ieee80211 or other
//   modules implementing ~IWirelessInterface
// - Also external interfaces can be configured for HW in the loop simulation
//   using the numEthInterfaces parameter and setting the interface type using
//   **.eth[*].typename in the INI file. see: ~ExtInterface derived modules and ~IExternalInterface
// - If wireless card is present, node mobility can be set using *.*.mobility.typename
//   see: inet.mobility and ~IMobility
//
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

This documentation is released under the Creative Commons license