Compound Module WirelessHost

Package: inet.node.inet
File: src/inet/node/inet/WirelessHost.ned

Models a host with (default) one wireless (802.11) card in infrastructure mode. This module is basically a StandardHost with an Ieee80211Nic with mgmtType = Ieee80211MgmtSTA added. It should be used in conjunction with AccessPoint, or any other AP model which contains Ieee80211Nic with mgmtType = Ieee80211MgmtAP.

Usage diagram:

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

Inheritance diagram:

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

Extends:

Name	Type	Description
StandardHost	compound module	IPv4 host with SCTP, TCP, UDP layers and applications. IP forwarding is disabled by default (see forwarding).

Known subclasses:

Name	Type	Description
AdhocHost	compound module	A wireless host containing routing, mobility and battery components. Supports only IPv4 protocol, TCP and UDP as transport protocol. This is a typical mobile node which can participate in adhoc routing and may have TCP/UDP applications installed. Supports ICMP (ping) too.
AODVRouter	compound module	It models a WirelessHost extended with AODVRouting submodule.
DYMORouter	compound module	TODO
GPSRRouter	compound module	TODO
Host	compound module	Wireless-enabled Host

Networks:

Name	Type	Description
AggregationTest2	network	(no description)
ConfiguratorD	network	(no description)
ConfiguratorF	network	(no description)
FilteringShowcase	network	(no description)
HandoverExample	network	(no description)
HandoverNetwork	network	(no description)
HiddenNodeShowcase	network	(no description)
Ieee80211VisualizationAdvancedFeaturesShowcase	network	(no description)
Ieee80211VisualizationDisplayingAssociationsShowcase	network	(no description)
Ieee80211VisualizationExample	network	(no description)
Ieee80211VisualizationVisualizingHandoverShowcase	network	(no description)
InstrumentShowcase	network	(no description)
InterfaceTableVisualizationAdvancedFeaturesShowcase	network	(no description)
InterfaceTableVisualizationExample	network	(no description)
Lan80211	network	(no description)
MacTest	network	(no description)
MediumActivityDisplayingPropagationTransmissionsReceptionsShowcase	network	(no description)
MobilityVisualizationExample	network	(no description)
MultiRadio	network	(no description)
NetworkPathRIPShowcase	network	TODO documentation
PacketDropQueueOverflowShowcase	network	(no description)
PhysicalLinkVisualizerFilteringShowcase	network	TODO documentation
PropagationD	network	(no description)
PropagationE	network	(no description)
QosThroughput	network	(no description)
RateControlExample	network	(no description)
ScalingExampleNetwork	network	(no description)
TestNic	network	(no description)
TestRadioScaling	network	(no description)
Throughput	network	(no description)
VisualizationD	network	(no description)
VisualizationE	network	(no description)
VisualizationH	network	(no description)
VisualizationTutorialA	network	(no description)
WiredAndWirelessHostsWithAP	network	(no description)
WirelessNetWith2DHCP	network	(no description)
WirelessNetWithDHCP	network	(no description)

Parameters:

Name	Type	Default value	Description
hasStatus	bool	false
numExtInterfaces	int	0
numRadios	int	1	the number of radios in the router. by default no wireless
numPcapRecorders	int	0	no of PcapRecorders.
numTunInterfaces	int	0
osgModel	string	""	3D model for OSG visualization, no 3D model by default
osgModelColor	string	""	tint color, no colorization by default
mobilityType	string	numRadios > 0 ? "StationaryMobility" : ""
networkLayerType	string	"IPv4NetworkLayer"
routingTableType	string	"IPv4RoutingTable"
forwarding	bool	false
multicastForwarding	bool	false
energyStorageType	string	""
energyManagementType	string	""
energyGeneratorType	string	""
numTcpApps	int	0	no of TCP apps. Specify the app types in INI file with tcpApp[0..1].typename="TCPEchoApp" syntax
numUdpApps	int	0	no of UDP apps. Specify the app types in INI file with udpApp[0..1].typename="UDPVideoStreamCli" syntax
numSctpApps	int	0	no of SCTP apps. Specify the app types in INI file with sctpApp[0..1].typename="SCTPServer" syntax
numPingApps	int	0	no of PING apps. Specify the app types in INI file with pingApp[0..1].typename="PingApp" syntax
hasTcp	bool	numTcpApps > 0
hasUdp	bool	numUdpApps > 0
hasSctp	bool	numSctpApps > 0
hasTun	bool	numTunInterfaces > 0
tcpType	string	firstAvailableOrEmpty("TCP", "TCP_lwIP", "TCP_NSC")	tcp implementation (e.g. TCP, TCP_lwIP, TCP_NSC) or TCPSpoof
udpType	string	firstAvailableOrEmpty("UDP")
sctpType	string	firstAvailableOrEmpty("SCTP")

Properties:

Name	Value	Description
display	i=device/wifilaptop
networkNode
labels	node

Gates:

Name	Direction	Size
radioIn [ ]	input	numRadios
pppg [ ]	inout
ethg [ ]	inout

Unassigned submodule parameters:

Name	Type	Default value	Description
status.initialStatus	string	"UP"	TODO @signal, @statistic
routingTable.forwarding	bool
routingTable.multicastForwarding	bool
interfaceTable.displayAddresses	bool	false	whether to display IP addresses on links
pcapRecorder.verbose	bool	false	whether to log packets on the module output
pcapRecorder.pcapFile	string	""	the PCAP file to be written
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[] ext[]"	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.alwaysFlush	bool	false	flush the pcapFile after each write to ensure that all packets are captured in case of a crash
lo0.lo.interfaceTableModule	string		The path to the InterfaceTable module
lo0.lo.mtu	int	4470B

Source code:

//
// Models a host with (default) one wireless (802.11) card in infrastructure mode.
// This module is basically a ~StandardHost with an ~Ieee80211Nic with
// mgmtType = ~Ieee80211MgmtSTA added.
// It should be used in conjunction with ~AccessPoint, or any other AP model
// which contains ~Ieee80211Nic with mgmtType = ~Ieee80211MgmtAP.
//
module WirelessHost extends StandardHost
{
    @display("i=device/wifilaptop");
    numRadios = default(1);
}