AodvRouter

Package: inet.node.aodv

AodvRouter

compound module

It models a WirelessHost extended with Aodv submodule.

AODV is an on-demand MANET routing protocol. Each node works similar to a 'router': they manage their own routing tables, send request for routes and consult the IP layer via Netfilter hooks for data forwarding.

Scenerios where AODV routing is desired use this module as a host module.

The AODV v.2 (known as Dymo) is also implemented: Dymo, DymoRouter.

See also: Aodv, Dymo, DymoRouter.

status : NodeStatus Keeps track of the status of network node (up, down, etc.) for other modules, and also displays it... Source: status: NodeStatus if hasStatus { @display("p=125,80;is=s"); } clock : like IClock IClock: This module interface is implemented by clock models. Source: clock: <default("")> like IClock if typename != "" { @display("p=125,320;is=s"); } energyStorage : like IEnergyStorage IEnergyStorage: The energy storage models describe devices that absorb energy produced by generators, and provide... Source: energyStorage: <default("")> like IEnergyStorage if typename != "" { @display("p=125,400;is=s"); } energyManagement : like IEnergyManagement IEnergyManagement: The energy management models monitors an energy storage, estimates its state, and controls the... Source: energyManagement: <default("")> like IEnergyManagement if typename != "" { @display("p=125,480;is=s"); } energyGenerator : like IEnergyGenerator IEnergyGenerator: The energy generator models describe the energy generation process of devices over time. Source: energyGenerator: <default("")> like IEnergyGenerator if typename != "" { @display("p=125,560;is=s"); } mobility : like IMobility IMobility: The module interface for mobility models. Source: mobility: <default("")> like IMobility if typename != "" { @display("p=125,160;is=s"); } measurer : like IMeasurer IMeasurer: This module interface is implemented by all standalone measurement modules. Source: measurer: <default("")> like IMeasurer if typename != "" { @display("p=125,660;is=s"); } pcapRecorder[numPcapRecorders] : PcapRecorder Records PCAP traces of frames sent/received by other modules within the same host. Source: pcapRecorder[numPcapRecorders]: PcapRecorder { @display("p=125,640;is=s"); } interfaceTable : InterfaceTable Keeps the table of network interfaces. Source: interfaceTable: InterfaceTable { @display("p=125,240;is=s"); } llc : like IIeee8022Llc Source: llc: <default("")> like IIeee8022Llc if typename != "" { @display("p=375,525"); } cb : MessageDispatcher This module connects multiple applications, protocols and interfaces with each other and... Source: cb: MessageDispatcher { @display("p=750,600;b=1000,5"); } bridging : like IProtocolLayer IProtocolLayer: This module interface is implemented by all protocol layer modules that connect to a higher and to... Source: bridging: <default("")> like IProtocolLayer if typename != "" { @display("p=750,675"); } bl : MessageDispatcher This module connects multiple applications, protocols and interfaces with each other and... Source: bl: MessageDispatcher { @display("p=750,750;b=1000,5"); } ethernet : like IEthernetLayer Source: ethernet: <default(sizeof(ethg) > 0 ? "EthernetEncapsulation" : "")> like IEthernetLayer if typename != "" { @display("p=375,825"); } ieee8021q : like IIeee8021qLayer Source: ieee8021q: <default("")> like IIeee8021qLayer if typename != "" { @display("p=525,825"); } ieee8021r : like IIeee8021rLayer Source: ieee8021r: <default("")> like IIeee8021rLayer if typename != "" { @display("p=675,825"); } li : MessageDispatcher This module connects multiple applications, protocols and interfaces with each other and... Source: li: MessageDispatcher { @display("p=750,900;b=1000,5,,,,1"); } lo[numLoInterfaces] : like ILoopbackInterface LoopbackInterface: This module implements a loopback network interface. ILoopbackInterface: This module interface is implemented by loopback network interfaces. Source: lo[numLoInterfaces]: <default("LoopbackInterface")> like ILoopbackInterface { @display("p=750,975,row,150"); } wlan[numWlanInterfaces] : like IWirelessInterface Ieee80211Interface: This module implements an IEEE 802.11 network interface. IWirelessInterface: This module interface is implemented by wireless network interfaces. Source: wlan[numWlanInterfaces]: <default("Ieee80211Interface")> like IWirelessInterface { @display("p=375,1000,row,150;q=queue"); } ppp[sizeof(pppg)] : like IPppInterface PppInterface: This module implements a PPP network interface. IPppInterface: This module interface is implemented by PPP network interfaces. Source: ppp[sizeof(pppg)]: <default("PppInterface")> like IPppInterface { @display("p=300,975,row,150;q=txQueue"); } eth[sizeof(ethg)] : like IEthernetInterface EthernetInterface: This module represents an Ethernet network interface. IEthernetInterface: This module interface is implemented by Ethernet network interfaces. Source: eth[sizeof(ethg)]: <default("EthernetInterface")> like IEthernetInterface { @display("p=900,975,row,150;q=txQueue"); } tun[numTunInterfaces] : like ITunnelInterface TunInterface: This module implements a TUN network interface. ITunnelInterface: This module interface is implemnted by tunnel network interfaces. Source: tun[numTunInterfaces]: <default("TunInterface")> like ITunnelInterface { @display("p=975,1000,row,150;q=txQueue"); } virt[numVirtInterfaces] : like IVirtualInterface VirtualInterface: This module implements a virtual network interface. IVirtualInterface: This module interface is implemnted by virtual network interfaces. Source: virt[numVirtInterfaces]: <default("VirtualInterface")> like IVirtualInterface { @display("p=975,1000,row,150;q=txQueue"); } ipv4 : like INetworkLayer Ipv4NetworkLayer: Network layer of an IPv4 node. Source: ipv4: <default("Ipv4NetworkLayer")> like INetworkLayer if hasIpv4 { @display("p=375,375;q=queue"); } ipv6 : like INetworkLayer Ipv6NetworkLayer: Represents an IPv6 network layer (L3). Source: ipv6: <default("Ipv6NetworkLayer")> like INetworkLayer if hasIpv6 { @display("p=525,375;q=queue"); } generic : like INetworkLayer Source: generic: <default("")> like INetworkLayer if hasGn { @display("p=675,375;q=queue"); } nl : MessageDispatcher This module connects multiple applications, protocols and interfaces with each other and... Source: nl: MessageDispatcher { @display("p=750,450;b=1000,5,,,,1"); } udp : like IUdp IUdp: UDP protocol interface. Source: udp: <default(firstAvailableOrEmpty("Udp"))> like IUdp if hasUdp { @display("p=375,225"); } tcp : like ITcp ITcp: Interface for TCP protocol implementations. Source: tcp: <default(firstAvailableOrEmpty("Tcp", "TcpLwip", "TcpNsc"))> like ITcp if hasTcp { @display("p=525,225"); } sctp : like ISctp ISctp: Interface for SCTP protocol. Source: sctp: <default(firstAvailableOrEmpty("Sctp"))> like ISctp if hasSctp { @display("p=675,225"); } tn : MessageDispatcher This module connects multiple applications, protocols and interfaces with each other and... Source: tn: MessageDispatcher { @display("p=750,300;b=1000,5,,,,1"); } app[numApps] : like IApp IApp: Generic application interface. Source: app[numApps]: <> like IApp { @display("p=375,75,row,150"); } at : MessageDispatcher This module connects multiple applications, protocols and interfaces with each other and... Source: at: MessageDispatcher { @display("p=750,150;b=1000,5,,,,1"); } aodv : Aodv Ad hoc On-Demand Distance Vector Routing Protocol module. Source: aodv: Aodv { @display("p=825,226"); }

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
AdhocHost compound module

A wireless host containing routing, mobility and energy components. Supports IPv4 network protocol, TCP, UDP, and SCTP 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.

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 1
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 true
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/cellphone

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
aodv.routingTableModule string "^.ipv4.routingTable"
aodv.interfaceTableModule string "^.interfaceTable"
aodv.networkProtocolModule string "^.ipv4.ip"
aodv.askGratuitousRREP bool false

see RFC 3561: 6.6.3
aodv.useHelloMessages bool false

see RFC 3561: 6.9
aodv.useLocalRepair bool false

see RFC 3561: 6.12 *not implemented yet*
aodv.destinationOnlyFlag bool false

see RFC 3561: 5.1
aodv.udpPort int 654
aodv.interface string "wlan0"
aodv.maxPeriodicJitter double helloInterval / 4

it MUST NOT be negative; it MUST NOT be greater than MESSAGE_INTERVAL/2; it SHOULD NOT be greater than MESSAGE_INTERVAL/4.
aodv.periodicJitter double uniform(0s, maxPeriodicJitter)

jitter for externally triggered message generation and message forwarding
aodv.maxJitter double 5ms

RFC 5148: need more revise: As well as the decision as to whether to use jitter being dependent on the medium access control and lower layers, the selection of the MAXJITTER parameter SHOULD be appropriate to those mechanisms.
aodv.jitter double uniform(0ms, maxJitter)

jitter for broadcasts
aodv.helloInterval double 1s

every helloInterval seconds a node broadcasts Hello messages (if it is necessary)
aodv.allowedHelloLoss int 2

allowedHelloLoss * helloInterval is the lifetime value for Hello messages
aodv.activeRouteTimeout double 3s

the timeout value for cached routes If Hello messages are used, then the ACTIVE_ROUTE_TIMEOUT parameter value MUST be more than the value (ALLOWED_HELLO_LOSS * HELLO_INTERVAL).
aodv.netDiameter int 35

the maximum possible number of hops between two nodes in the network
aodv.nodeTraversalTime double 0.04s

an estimation of the average one-hop traversal time
aodv.rerrRatelimit int 10

maximum number of RERR messages that the AODV may originate in 1s.
aodv.rreqRetries int 2

specifies the number of times AODV will repeat an expanded ring search for a destination
aodv.rreqRatelimit int 10

maximum number of RREQ messages that the AODV may originate in 1s.
aodv.timeoutBuffer int 2

plus time to wait for a delayed RREP (due to congestion) (to omit this buffer set it to 0)
aodv.ttlStart int 2

specifies the TTL value when initiating a route request
aodv.ttlIncrement int 2

specifies the value by which the TTL will be incremented each time a RREQ is retransmitted
aodv.ttlThreshold int 7

the maximum value of TTL over which NET_DIAMETER value will be used to broadcast any RREQ
aodv.localAddTTL int 2

it is used by the formula which calculates the initial TTL of the RREQ for a local repair
aodv.myRouteTimeout double 2 * activeRouteTimeout

the value of the lifetime field that a destination node places in RREPs
aodv.deletePeriod double 5 * max(activeRouteTimeout, helloInterval)

the time after which an expired route is deleted
aodv.blacklistTimeout double rreqRetries * netTraversalTime

the time after which a blacklisted node is removed from the blacklist
aodv.netTraversalTime double 2 * nodeTraversalTime * netDiameter

an estimation of the traversal time for the complete network
aodv.nextHopWait double nodeTraversalTime + 0.01s

timeout for a RREP-ACK
aodv.pathDiscoveryTime double 2 * netTraversalTime

buffer timeout for each broadcasted RREQ message

Source code

//
// It models a ~WirelessHost extended with ~Aodv submodule.
//
// AODV is an on-demand MANET routing protocol. Each node
// works similar to a 'router': they manage their own routing
// tables, send request for routes and consult the IP layer via
// Netfilter hooks for data forwarding.
//
// Scenerios where AODV routing is desired use this module as a
// host module.
//
// The AODV v.2 (known as Dymo) is also implemented: ~Dymo,
// ~DymoRouter.
//
// @see ~Aodv, ~Dymo, ~DymoRouter.
//
module AodvRouter extends AdhocHost
{
    submodules:
        aodv: Aodv {
            @display("p=825,226");
        }
    connections:
        aodv.socketOut --> at.in++;
        aodv.socketIn <-- at.out++;
}
File: src/inet/node/aodv/AodvRouter.ned

This documentation is released under the Creative Commons license