\IP router.

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).

Parameters

Name	Type	Default value	Description
hasStatus	bool	false
numExtInterfaces	int	0
numRadios	int	0	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	true
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/pc2
networkNode
labels	node

Gates

Name	Direction	Size	Description
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
natHook.interfaceTableModule	string
natHook.networkProtocolModule	string
natHook.routingTableModule	string
natHook.natTableModule	string

Source code

//
// \IP router.
//
module SCTPNatRouter extends StandardHost
{
    parameters:
        forwarding = true;
        natHook.networkProtocolModule = default(absPath(".networkLayer.ip"));
        natHook.natTableModule = default(absPath(".natTable"));
    submodules:
        natHook: SCTPNatHook {
            parameters:
                @display("p=160,132;i=block/table");
        }
        natTable: SCTPNatTable {
            parameters:
                @display("p=60,132;i=block/table");
        }
    connections:
        natHook.out --> networkLayer.transportIn++;
        natHook.in <-- networkLayer.transportOut++;
}

File: src/inet/transportlayer/sctp/SCTPNatRouter.ned

---

This documentation is released under the Creative Commons license