Public Member Functions | Static Public Member Functions | Static Public Attributes

ns3::aodv::RoutingProtocol Class Reference
[AODV]

AODV routing protocol. More...

#include <aodv-routing-protocol.h>

Inheritance diagram for ns3::aodv::RoutingProtocol:
Inheritance graph
[legend]
Collaboration diagram for ns3::aodv::RoutingProtocol:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 RoutingProtocol ()
 c-tor
virtual void DoDispose ()
From Ipv4RoutingProtocol

Ptr< Ipv4Route > RouteOutput (Ptr< Packet > p, const Ipv4Header &header, Ptr< NetDevice > oif, Socket::SocketErrno &sockerr)
 Query routing cache for an existing route, for an outbound packet.
bool RouteInput (Ptr< const Packet > p, const Ipv4Header &header, Ptr< const NetDevice > idev, UnicastForwardCallback ucb, MulticastForwardCallback mcb, LocalDeliverCallback lcb, ErrorCallback ecb)
virtual void NotifyInterfaceUp (uint32_t interface)
virtual void NotifyInterfaceDown (uint32_t interface)
virtual void NotifyAddAddress (uint32_t interface, Ipv4InterfaceAddress address)
virtual void NotifyRemoveAddress (uint32_t interface, Ipv4InterfaceAddress address)
virtual void SetIpv4 (Ptr< Ipv4 > ipv4)
Handle protocol parameters

bool GetDesinationOnlyFlag () const
void SetDesinationOnlyFlag (bool f)
bool GetGratuitousReplyFlag () const
void SetGratuitousReplyFlag (bool f)
void SetHelloEnable (bool f)
bool GetHelloEnable () const
void SetBroadcastEnable (bool f)
bool GetBroadcastEnable () const

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::aodv::RoutingProtocol.

Static Public Attributes

static const uint32_t AODV_PORT

Detailed Description

AODV routing protocol.

Member Function Documentation

virtual void ns3::aodv::RoutingProtocol::DoDispose (  )  [virtual]

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden version of this method and chain up to their parent's implementation once they are done. i.e., for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose method.

It is safe to call GetObject from within this method.

Reimplemented from ns3::Object.

static TypeId ns3::aodv::RoutingProtocol::GetTypeId ( void   )  [static]

This method returns the TypeId associated to ns3::aodv::RoutingProtocol.

Attributes defined for this type:

  • HelloInterval: HELLO messages emission interval.
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: 1000000000ns
    • Flags: construct write read
  • RreqRetries: Maximum number of retransmissions of RREQ to discover a route
  • RreqRateLimit: Maximum number of RREQ per second.
  • NodeTraversalTime: Conservative estimate of the average one hop traversal time for packets and should include queuing delays, interrupt processing times and transfer times.
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: 40000000ns
    • Flags: construct write read
  • NextHopWait: Period of our waiting for the neighbour's RREP_ACK = 10 ms + NodeTraversalTime
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: 50000000ns
    • Flags: construct write read
  • ActiveRouteTimeout: Period of time during which the route is considered to be valid
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: 3000000000ns
    • Flags: construct write read
  • MyRouteTimeout: Value of lifetime field in RREP generating by this node = 2 * max(ActiveRouteTimeout, PathDiscoveryTime)
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: 11200000000ns
    • Flags: construct write read
  • BlackListTimeout: Time for which the node is put into the blacklist = RreqRetries * NetTraversalTime
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: 5600000000ns
    • Flags: construct write read
  • DeletePeriod: DeletePeriod is intended to provide an upper bound on the time for which an upstream node A can have a neighbor B as an active next hop for destination D, while B has invalidated the route to D. = 5 * max (HelloInterval, ActiveRouteTimeout)
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: 15000000000ns
    • Flags: construct write read
  • TimeoutBuffer: Its purpose is to provide a buffer for the timeout so that if the RREP is delayed due to congestion, a timeout is less likely to occur while the RREP is still en route back to the source.
  • NetDiameter: Net diameter measures the maximum possible number of hops between two nodes in the network
  • NetTraversalTime: Estimate of the average net traversal time = 2 * NodeTraversalTime * NetDiameter
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: 2800000000ns
    • Flags: construct write read
  • PathDiscoveryTime: Estimate of maximum time needed to find route in network = 2 * NetTraversalTime
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: 5600000000ns
    • Flags: construct write read
  • MaxQueueLen: Maximum number of packets that we allow a routing protocol to buffer.
  • MaxQueueTime: Maximum time packets can be queued (in seconds)
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: 30000000000ns
    • Flags: construct write read
  • AllowedHelloLoss: Number of hello messages which may be loss for valid link.
  • GratuitousReply: Indicates whether a gratuitous RREP should be unicast to the node originated route discovery.
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: construct write read
  • DestinationOnly: Indicates only the destination may respond to this RREQ.
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: construct write read
  • EnableHello: Indicates whether a hello messages enable.
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: construct write read
  • EnableBroadcast: Indicates whether a broadcast data packets forwarding enable.
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: construct write read

No TraceSources defined for this type.

Reimplemented from ns3::Ipv4RoutingProtocol.

virtual void ns3::aodv::RoutingProtocol::NotifyAddAddress ( uint32_t  interface,
Ipv4InterfaceAddress  address 
) [virtual]
Parameters:
interface the index of the interface we are being notified about
address a new address being added to an interface

Protocols are expected to implement this method to be notified whenever a new address is added to an interface. Typically used to add a 'network route' on an interface. Can be invoked on an up or down interface.

Implements ns3::Ipv4RoutingProtocol.

virtual void ns3::aodv::RoutingProtocol::NotifyInterfaceDown ( uint32_t  interface  )  [virtual]
Parameters:
interface the index of the interface we are being notified about

Protocols are expected to implement this method to be notified of the state change of an interface in a node.

Implements ns3::Ipv4RoutingProtocol.

virtual void ns3::aodv::RoutingProtocol::NotifyInterfaceUp ( uint32_t  interface  )  [virtual]
Parameters:
interface the index of the interface we are being notified about

Protocols are expected to implement this method to be notified of the state change of an interface in a node.

Implements ns3::Ipv4RoutingProtocol.

virtual void ns3::aodv::RoutingProtocol::NotifyRemoveAddress ( uint32_t  interface,
Ipv4InterfaceAddress  address 
) [virtual]
Parameters:
interface the index of the interface we are being notified about
address a new address being added to an interface

Protocols are expected to implement this method to be notified whenever a new address is removed from an interface. Typically used to remove the 'network route' of an interface. Can be invoked on an up or down interface.

Implements ns3::Ipv4RoutingProtocol.

Ptr<Ipv4Route> ns3::aodv::RoutingProtocol::RouteOutput ( Ptr< Packet >  p,
const Ipv4Header &  header,
Ptr< NetDevice >  oif,
Socket::SocketErrno &  sockerr 
) [virtual]

Query routing cache for an existing route, for an outbound packet.

This lookup is used by transport protocols. It does not cause any packet to be forwarded, and is synchronous. Can be used for multicast or unicast. The Linux equivalent is ip_route_output()

Parameters:
p packet to be routed. Note that this method may modify the packet. Callers may also pass in a null pointer.
header input parameter (used to form key to search for the route)
oif Output interface Netdevice. May be zero, or may be bound via socket options to a particular output interface.
sockerr Output parameter; socket errno
Returns:
a code that indicates what happened in the lookup

Implements ns3::Ipv4RoutingProtocol.

virtual void ns3::aodv::RoutingProtocol::SetIpv4 ( Ptr< Ipv4 >  ipv4  )  [virtual]
Parameters:
ipv4 the ipv4 object this routing protocol is being associated with

Typically, invoked directly or indirectly from ns3::Ipv4::SetRoutingProtocol

Implements ns3::Ipv4RoutingProtocol.

The documentation for this class was generated from the following files:
Generated on Fri Feb 18 2011 17:01:49 for NS-3 by  doxygen 1.7.1