Router

compound module

IPv4 router that supports wireless, Ethernet, PPP and external interfaces. By default, no wireless and external interfaces are added; the number of Ethernet and PPP ports depends on the external connections.

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. Wirless 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 type using **.ext.typename in the INI file. see: ExtInterface derived modules and IExternalInterface
PPP queueing type can be set using **.ppp.queue.typename see: PppInterface
If wireless card is present, node mobility can be set using **.mobility.typename see: inet.mobility and IMobility

By default, dynamic routing is not supported. Specific routing protocols can be added by setting the hasOspf/hasRip/hasBgp parameters.

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.

Known subclasses

Name	Type	Description
BgpRouter	compound module	IP router with BGPv4 and OSPFv4 support.
MulticastRouter	compound module	(no description)
OspfRouter	compound module	An OSPFv2 router.
Ospfv3Router	compound module	An OSPFv3 router.
RipRouter	compound module	An RIPv2 router.
Router6	compound module	IPv6 router.

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
numPcapRecorders	int	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
numVlanInterfaces	int	0
hasIpv4	bool	true
hasIpv6	bool	false
hasGn	bool	false
forwarding	bool	true
multicastForwarding	bool	false
hasUdp	bool	hasRip \|\| hasDhcp
hasTcp	bool	hasBgp
hasSctp	bool	false
numApps	int	0
hasOspf	bool	false
hasRip	bool	false
hasBgp	bool	false
hasPim	bool	false
hasDhcp	bool	false

Properties

Name	Value	Description
networkNode
labels	node
display	i=abstract/router

Gates

Name	Direction	Size
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	false	whether to log packets on the module output
pcapRecorder.pcapFile	string	""	the PCAP file to be written
pcapRecorder.pcapLinkType	int	-1	the network type header field in the PCAP file, see http://www.tcpdump.org/linktypes.html (1=ethernet, 204=ppp, 105=IEEE 802.11, ...) (-1 means autodetect based on first recordable packet)
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	string	"*"	which packets are considered, matches all packets by default
pcapRecorder.packetDataFilter	string	"*"	which packets are considered based on the data they contain, 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
bgp.interfaceTableModule	string		The path to the InterfaceTable module
bgp.routingTableModule	string
bgp.ospfRoutingModule	string	hasOspf ? "^.ospf" : ""

Source code

//
// IPv4 router that supports wireless, Ethernet, PPP and external interfaces.
// By default, no wireless and external interfaces are added; the number of
// Ethernet and PPP ports depends on the external connections.
//
// - 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. Wirless 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 type using
//   **.ext.typename in the INI file. see: ~ExtInterface derived modules and ~IExternalInterface
// - PPP queueing type can be set using **.ppp.queue.typename see: ~PppInterface
// - If wireless card is present, node mobility can be set using **.mobility.typename
//   see: inet.mobility and ~IMobility
//
// By default, dynamic routing is not supported. Specific routing protocols can
// be added by setting the hasOspf/hasRip/hasBgp parameters.
//
module Router extends ApplicationLayerNodeBase
{
    parameters:
        @display("i=abstract/router");
        @figure[submodules];
        forwarding = true;
        bool hasOspf = default(false);
        bool hasRip = default(false);
        bool hasBgp = default(false);
        bool hasPim = default(false);
        bool hasDhcp = default(false);
        hasUdp = default(hasRip || hasDhcp);
        hasTcp = default(hasBgp);
        *.routingTableModule = default("^.ipv4.routingTable");

    submodules:
        ospf: <default("Ospfv2")> like IOspf if hasOspf {
            parameters:
                @display("p=975,226");
        }
        bgp: <"Bgp"> like IBgp if hasBgp {
            parameters:
                ospfRoutingModule = default(hasOspf ? "^.ospf" : "");
                @display("p=600,100");
        }
        rip: <"Rip"> like IApp if hasRip {
            parameters:
                @display("p=975,76");
        }
        pim: <"Pim"> like IPim if hasPim {
            parameters:
                @display("p=825,226");
        }
        dhcp: <"DhcpServer"> like IApp if hasDhcp {
            parameters:
                @display("p=1125,76");
        }

    connections allowunconnected:
        ospf.ipOut --> tn.in++ if hasOspf;
        ospf.ipIn <-- tn.out++ if hasOspf;

        bgp.socketOut --> at.in++ if hasBgp;
        bgp.socketIn <-- at.out++ if hasBgp;

        rip.socketOut --> at.in++ if hasRip;
        rip.socketIn <-- at.out++ if hasRip;

        pim.networkLayerOut --> tn.in++ if hasPim;
        pim.networkLayerIn <-- tn.out++ if hasPim;

        dhcp.socketOut --> at.in++ if hasDhcp;
        dhcp.socketIn <-- at.out++ if hasDhcp;
}

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