A Discrete-Event Network Simulator
API
ns3::dsdv::RoutingProtocol Class Reference

DSDV routing protocol. More...

#include "dsdv-routing-protocol.h"

+ Inheritance diagram for ns3::dsdv::RoutingProtocol:
+ Collaboration diagram for ns3::dsdv::RoutingProtocol:

Public Member Functions

 RoutingProtocol ()
 c-tor More...
 
virtual ~RoutingProtocol ()
 
int64_t AssignStreams (int64_t stream)
 Assign a fixed random variable stream number to the random variables used by this model. More...
 
virtual void DoDispose ()
 Destructor implementation. More...
 
bool GetEnableBufferFlag () const
 Get enable buffer flag. More...
 
bool GetEnableRAFlag () const
 Get enable route aggregation (RA) flag. More...
 
bool GetWSTFlag () const
 Get weighted settling time (WST) flag. More...
 
virtual void NotifyAddAddress (uint32_t interface, Ipv4InterfaceAddress address)
 
virtual void NotifyInterfaceDown (uint32_t interface)
 
virtual void NotifyInterfaceUp (uint32_t interface)
 
virtual void NotifyRemoveAddress (uint32_t interface, Ipv4InterfaceAddress address)
 
virtual void PrintRoutingTable (Ptr< OutputStreamWrapper > stream, Time::Unit unit=Time::S) const
 Print the Routing Table entries. More...
 
bool RouteInput (Ptr< const Packet > p, const Ipv4Header &header, Ptr< const NetDevice > idev, UnicastForwardCallback ucb, MulticastForwardCallback mcb, LocalDeliverCallback lcb, ErrorCallback ecb)
 Route input packet. More...
 
Ptr< Ipv4RouteRouteOutput (Ptr< Packet > p, const Ipv4Header &header, Ptr< NetDevice > oif, Socket::SocketErrno &sockerr)
 Query routing cache for an existing route, for an outbound packet. More...
 
void SetEnableBufferFlag (bool f)
 Set enable buffer flag. More...
 
void SetEnableRAFlag (bool f)
 Set enable route aggregation (RA) flag. More...
 
virtual void SetIpv4 (Ptr< Ipv4 > ipv4)
 
void SetWSTFlag (bool f)
 Set weighted settling time (WST) flag. More...
 
virtual void NotifyAddAddress (uint32_t interface, Ipv4InterfaceAddress address)=0
 
virtual void NotifyInterfaceDown (uint32_t interface)=0
 
virtual void NotifyInterfaceUp (uint32_t interface)=0
 
virtual void NotifyRemoveAddress (uint32_t interface, Ipv4InterfaceAddress address)=0
 
virtual void PrintRoutingTable (Ptr< OutputStreamWrapper > stream, Time::Unit unit=Time::S) const =0
 Print the Routing Table entries. More...
 
virtual bool RouteInput (Ptr< const Packet > p, const Ipv4Header &header, Ptr< const NetDevice > idev, UnicastForwardCallback ucb, MulticastForwardCallback mcb, LocalDeliverCallback lcb, ErrorCallback ecb)=0
 Route an input packet (to be forwarded or locally delivered) More...
 
virtual Ptr< Ipv4RouteRouteOutput (Ptr< Packet > p, const Ipv4Header &header, Ptr< NetDevice > oif, Socket::SocketErrno &sockerr)=0
 Query routing cache for an existing route, for an outbound packet. More...
 
virtual void SetIpv4 (Ptr< Ipv4 > ipv4)=0
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
virtual TypeId GetInstanceTypeId (void) const =0
 Get the most derived TypeId for this Object. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Ipv4RoutingProtocol
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Static Public Attributes

static const uint32_t DSDV_PORT = 269
 UDP Port for DSDV control traffic. More...
 

Private Member Functions

void DeferredRouteOutput (Ptr< const Packet > p, const Ipv4Header &header, UnicastForwardCallback ucb, ErrorCallback ecb)
 Queue packet until we find a route. More...
 
void Drop (Ptr< const Packet > packet, const Ipv4Header &header, Socket::SocketErrno err)
 Notify that packet is dropped for some reason. More...
 
Ptr< SocketFindSocketWithInterfaceAddress (Ipv4InterfaceAddress iface) const
 Find socket with local interface address iface. More...
 
Time GetSettlingTime (Ipv4Address dst)
 Get settlingTime for a destination. More...
 
void LookForQueuedPackets (void)
 Look for any queued packets to send them out. More...
 
Ptr< Ipv4RouteLoopbackRoute (const Ipv4Header &header, Ptr< NetDevice > oif) const
 Create loopback route for given header. More...
 
void MergeTriggerPeriodicUpdates ()
 Merge periodic updates. More...
 
void RecvDsdv (Ptr< Socket > socket)
 Receive and process dsdv control packet. More...
 
void Send (Ptr< Ipv4Route > route, Ptr< const Packet > packet, const Ipv4Header &header)
 Send a packet. More...
 
void SendPacketFromQueue (Ipv4Address dst, Ptr< Ipv4Route > route)
 Send packet from queue. More...
 
void SendPeriodicUpdate ()
 Broadcasts the entire routing table for every PeriodicUpdateInterval. More...
 
void SendTriggeredUpdate ()
 Sends trigger update from a node. More...
 
void Start ()
 Start protocol operation. More...
 

Private Attributes

bool EnableBuffering
 Flag that is used to enable or disable buffering. More...
 
bool EnableRouteAggregation
 This is a flag to enable route aggregation. More...
 
bool EnableWST
 Flag that is used to enable or disable Weighted Settling Time. More...
 
uint32_t Holdtimes
 Holdtimes is the multiplicative factor of PeriodicUpdateInterval for which the node waits since the last update before flushing a route from the routing table. More...
 
RoutingTable m_advRoutingTable
 Advertised Routing table for the node. More...
 
ErrorCallback m_ecb
 Error callback for own packets. More...
 
Ptr< Ipv4m_ipv4
 IP protocol. More...
 
Ptr< NetDevicem_lo
 Loopback device used to defer route requests until a route is found. More...
 
Ipv4Address m_mainAddress
 Nodes IP address. More...
 
uint32_t m_maxQueuedPacketsPerDst
 The maximum number of packets that we allow per destination to buffer. More...
 
uint32_t m_maxQueueLen
 The maximum number of packets that we allow a routing protocol to buffer. More...
 
Time m_maxQueueTime
 The maximum period of time that a routing protocol is allowed to buffer a packet for. More...
 
Time m_periodicUpdateInterval
 PeriodicUpdateInterval specifies the periodic time interval between which the a node broadcasts its entire routing table. More...
 
Timer m_periodicUpdateTimer
 Timer to trigger periodic updates from a node. More...
 
PacketQueue m_queue
 A "drop front on full" queue used by the routing layer to buffer packets to which it does not have a route. More...
 
Time m_routeAggregationTime
 Parameter that holds the route aggregation time interval. More...
 
RoutingTable m_routingTable
 Main Routing table for the node. More...
 
UnicastForwardCallback m_scb
 Unicast callback for own packets. More...
 
Time m_settlingTime
 SettlingTime specifies the time for which a node waits before propagating an update. More...
 
std::map< Ptr< Socket >, Ipv4InterfaceAddressm_socketAddresses
 Raw socket per each IP interface, map socket -> iface address (IP + mask) More...
 
Timer m_triggeredExpireTimer
 Timer used by the trigger updates in case of Weighted Settling Time is used. More...
 
Ptr< UniformRandomVariablem_uniformRandomVariable
 Provides uniform random variables. More...
 
double m_weightedFactor
 This is the wighted factor to determine the weighted settling time. More...
 

Additional Inherited Members

- Public Types inherited from ns3::Ipv4RoutingProtocol
typedef Callback< void, Ptr< const Packet >, const Ipv4Header &, Socket::SocketErrnoErrorCallback
 Callback for routing errors (e.g., no route found) More...
 
typedef Callback< void, Ptr< const Packet >, const Ipv4Header &, uint32_tLocalDeliverCallback
 Callback for packets to be locally delivered. More...
 
typedef Callback< void, Ptr< Ipv4MulticastRoute >, Ptr< const Packet >, const Ipv4Header & > MulticastForwardCallback
 Callback for multicast packets to be forwarded. More...
 
typedef Callback< void, Ptr< Ipv4Route >, Ptr< const Packet >, const Ipv4Header & > UnicastForwardCallback
 Callback for unicast packets to be forwarded. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

DSDV routing protocol.

Config Paths

ns3::dsdv::RoutingProtocol is accessible through the following paths with Config::Set and Config::Connect:

  • "/NodeList/[i]/$ns3::dsdv::RoutingProtocol"

Attributes

  • PeriodicUpdateInterval: Periodic interval between exchange of full routing tables among nodes.
    • Set with class: ns3::TimeValue
    • Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
    • Initial value: +1.5e+10ns
    • Flags: constructwriteread
  • SettlingTime: Minimum time an update is to be stored in adv table before sending out in case of change in metric (in seconds)
    • Set with class: ns3::TimeValue
    • Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
    • Initial value: +5e+09ns
    • Flags: constructwriteread
  • MaxQueueLen: Maximum number of packets that we allow a routing protocol to buffer.
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 0:4294967295
    • Initial value: 500
    • Flags: constructwriteread
  • MaxQueuedPacketsPerDst: Maximum number of packets that we allow per destination to buffer.
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 0:4294967295
    • Initial value: 5
    • Flags: constructwriteread
  • MaxQueueTime: Maximum time packets can be queued (in seconds)
    • Set with class: ns3::TimeValue
    • Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
    • Initial value: +3e+10ns
    • Flags: constructwriteread
  • EnableBuffering: Enables buffering of data packets if no route to destination is available
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: constructwriteread
  • EnableWST: Enables Weighted Settling Time for the updates before advertising
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: constructwriteread
  • Holdtimes: Times the forwarding Interval to purge the route.
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 0:4294967295
    • Initial value: 3
    • Flags: constructwriteread
  • WeightedFactor: WeightedFactor for the settling time if Weighted Settling Time is enabled
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 0.875
    • Flags: constructwriteread
  • EnableRouteAggregation: Enables Weighted Settling Time for the updates before advertising
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: constructwriteread
  • RouteAggregationTime: Time to aggregate updates before sending them out (in seconds)
    • Set with class: ns3::TimeValue
    • Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
    • Initial value: +1e+09ns
    • Flags: constructwriteread

No TraceSources are defined for this type.
Size of this type is 552 bytes (on a 64-bit architecture).

Definition at line 53 of file dsdv-routing-protocol.h.

Constructor & Destructor Documentation

◆ RoutingProtocol()

ns3::dsdv::RoutingProtocol::RoutingProtocol ( )

c-tor

Definition at line 224 of file dsdv-routing-protocol.cc.

References m_uniformRandomVariable.

◆ ~RoutingProtocol()

ns3::dsdv::RoutingProtocol::~RoutingProtocol ( )
virtual

Definition at line 233 of file dsdv-routing-protocol.cc.

Member Function Documentation

◆ AssignStreams()

int64_t ns3::dsdv::RoutingProtocol::AssignStreams ( int64_t  stream)

Assign a fixed random variable stream number to the random variables used by this model.

Return the number of streams (possibly zero) that have been assigned.

Parameters
streamfirst stream index to use
Returns
the number of stream indices assigned by this model

Definition at line 217 of file dsdv-routing-protocol.cc.

References m_uniformRandomVariable, NS_LOG_FUNCTION, and ns3::RandomVariableStream::SetStream().

+ Here is the call graph for this function:

◆ DeferredRouteOutput()

void ns3::dsdv::RoutingProtocol::DeferredRouteOutput ( Ptr< const Packet p,
const Ipv4Header header,
UnicastForwardCallback  ucb,
ErrorCallback  ecb 
)
private

Queue packet until we find a route.

Parameters
pthe packet to route
headerthe Ipv4Header
ucbthe UnicastForwardCallback function
ecbthe ErrorCallback function

Definition at line 369 of file dsdv-routing-protocol.cc.

References ns3::dsdv::PacketQueue::Enqueue(), ns3::Packet::GetUid(), m_queue, NS_ASSERT, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by RouteInput().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ DoDispose()

void ns3::dsdv::RoutingProtocol::DoDispose ( void  )
virtual

Destructor implementation.

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

Subclasses are expected to implement their real destruction code in an overridden 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.

Definition at line 238 of file dsdv-routing-protocol.cc.

References ns3::Object::DoDispose(), m_ipv4, and m_socketAddresses.

+ Here is the call graph for this function:

◆ Drop()

void ns3::dsdv::RoutingProtocol::Drop ( Ptr< const Packet packet,
const Ipv4Header header,
Socket::SocketErrno  err 
)
private

Notify that packet is dropped for some reason.

Parameters
packetthe dropped packet
headerthe IPv4 header
errthe error number

Definition at line 1130 of file dsdv-routing-protocol.cc.

References ns3::Ipv4Header::GetDestination(), ns3::Packet::GetUid(), m_mainAddress, and NS_LOG_DEBUG.

Referenced by Start().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ FindSocketWithInterfaceAddress()

Ptr< Socket > ns3::dsdv::RoutingProtocol::FindSocketWithInterfaceAddress ( Ipv4InterfaceAddress  iface) const
private

Find socket with local interface address iface.

Parameters
ifacethe interface
Returns
the socket

Definition at line 1102 of file dsdv-routing-protocol.cc.

References m_socketAddresses.

Referenced by NotifyAddAddress(), NotifyInterfaceDown(), and NotifyRemoveAddress().

+ Here is the caller graph for this function:

◆ GetEnableBufferFlag()

bool ns3::dsdv::RoutingProtocol::GetEnableBufferFlag ( ) const

Get enable buffer flag.

Returns
the enable buffer flag

Definition at line 191 of file dsdv-routing-protocol.cc.

References EnableBuffering.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetEnableRAFlag()

bool ns3::dsdv::RoutingProtocol::GetEnableRAFlag ( ) const

Get enable route aggregation (RA) flag.

Returns
the enable route aggregation (RA) flag

Definition at line 211 of file dsdv-routing-protocol.cc.

References EnableRouteAggregation.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetSettlingTime()

Time ns3::dsdv::RoutingProtocol::GetSettlingTime ( Ipv4Address  dst)
private

Get settlingTime for a destination.

Parameters
dst- destination address
Returns
settlingTime for the destination if found

Definition at line 1206 of file dsdv-routing-protocol.cc.

References first::address, ns3::Time::As(), EnableWST, ns3::dsdv::RoutingTableEntry::GetLifeTime(), ns3::dsdv::RoutingTableEntry::GetSettlingTime(), ns3::dsdv::RoutingTable::LookupRoute(), m_routingTable, m_weightedFactor, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::Time::S, and ns3::Seconds().

Referenced by RecvDsdv().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetTypeId()

◆ GetWSTFlag()

bool ns3::dsdv::RoutingProtocol::GetWSTFlag ( ) const

Get weighted settling time (WST) flag.

Returns
the weighted settling time (WST) flag

Definition at line 201 of file dsdv-routing-protocol.cc.

References EnableWST.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ LookForQueuedPackets()

void ns3::dsdv::RoutingProtocol::LookForQueuedPackets ( void  )
private

◆ LoopbackRoute()

Ptr< Ipv4Route > ns3::dsdv::RoutingProtocol::LoopbackRoute ( const Ipv4Header header,
Ptr< NetDevice oif 
) const
private

Create loopback route for given header.

Parameters
headerthe IP header
oifthe device
Returns
the route

Definition at line 519 of file dsdv-routing-protocol.cc.

References ns3::Ipv4Header::GetDestination(), m_ipv4, m_lo, m_socketAddresses, NS_ASSERT, and NS_ASSERT_MSG.

Referenced by RouteOutput().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ MergeTriggerPeriodicUpdates()

◆ NotifyAddAddress()

void ns3::dsdv::RoutingProtocol::NotifyAddAddress ( uint32_t  interface,
Ipv4InterfaceAddress  address 
)
virtual
Parameters
interfacethe index of the interface we are being notified about
addressa 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.

Definition at line 1040 of file dsdv-routing-protocol.cc.

References first::address, ns3::dsdv::RoutingTable::AddRoute(), ns3::Socket::Bind(), ns3::Socket::BindToNetDevice(), ns3::Socket::CreateSocket(), DSDV_PORT, FindSocketWithInterfaceAddress(), ns3::Ipv4Address::GetAny(), ns3::Ipv4InterfaceAddress::GetBroadcast(), ns3::Ipv4InterfaceAddress::GetLocal(), ns3::Simulator::GetMaximumSimulationTime(), ns3::UdpSocketFactory::GetTypeId(), m_ipv4, m_routingTable, m_socketAddresses, ns3::MakeCallback(), NS_ASSERT, NS_LOG_FUNCTION, RecvDsdv(), ns3::Socket::SetAllowBroadcast(), and ns3::Socket::SetRecvCallback().

+ Here is the call graph for this function:

◆ NotifyInterfaceDown()

void ns3::dsdv::RoutingProtocol::NotifyInterfaceDown ( uint32_t  interface)
virtual
Parameters
interfacethe 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.

Definition at line 1021 of file dsdv-routing-protocol.cc.

References ns3::dsdv::RoutingTable::Clear(), ns3::Socket::Close(), ns3::dsdv::RoutingTable::DeleteAllRoutesFromInterface(), FindSocketWithInterfaceAddress(), m_advRoutingTable, m_ipv4, m_routingTable, m_socketAddresses, NS_ASSERT, and NS_LOG_LOGIC.

+ Here is the call graph for this function:

◆ NotifyInterfaceUp()

void ns3::dsdv::RoutingProtocol::NotifyInterfaceUp ( uint32_t  interface)
virtual
Parameters
interfacethe 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.

Definition at line 984 of file dsdv-routing-protocol.cc.

References ns3::dsdv::RoutingTable::AddRoute(), ns3::Socket::Bind(), ns3::Socket::BindToNetDevice(), ns3::Socket::CreateSocket(), DSDV_PORT, ns3::Ipv4Address::GetAny(), ns3::Simulator::GetMaximumSimulationTime(), ns3::UdpSocketFactory::GetTypeId(), m_ipv4, m_mainAddress, m_routingTable, m_socketAddresses, ns3::MakeCallback(), NS_ASSERT, NS_LOG_FUNCTION, RecvDsdv(), ns3::Socket::SetAllowBroadcast(), ns3::ObjectBase::SetAttribute(), and ns3::Socket::SetRecvCallback().

+ Here is the call graph for this function:

◆ NotifyRemoveAddress()

void ns3::dsdv::RoutingProtocol::NotifyRemoveAddress ( uint32_t  interface,
Ipv4InterfaceAddress  address 
)
virtual
Parameters
interfacethe index of the interface we are being notified about
addressa 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.

Definition at line 1078 of file dsdv-routing-protocol.cc.

References first::address, ns3::Socket::Bind(), ns3::Socket::CreateSocket(), DSDV_PORT, FindSocketWithInterfaceAddress(), ns3::Ipv4Address::GetAny(), ns3::UdpSocketFactory::GetTypeId(), m_ipv4, m_socketAddresses, ns3::MakeCallback(), NS_ASSERT, RecvDsdv(), ns3::Socket::SetAllowBroadcast(), and ns3::Socket::SetRecvCallback().

+ Here is the call graph for this function:

◆ PrintRoutingTable()

void ns3::dsdv::RoutingProtocol::PrintRoutingTable ( Ptr< OutputStreamWrapper stream,
Time::Unit  unit = Time::S 
) const
virtual

Print the Routing Table entries.

Parameters
streamThe ostream the Routing table is printed to
unitThe time unit to be used in the report

Implements ns3::Ipv4RoutingProtocol.

Definition at line 251 of file dsdv-routing-protocol.cc.

References ns3::Time::As(), ns3::OutputStreamWrapper::GetStream(), m_ipv4, m_routingTable, ns3::Now(), and ns3::dsdv::RoutingTable::Print().

+ Here is the call graph for this function:

◆ RecvDsdv()

void ns3::dsdv::RoutingProtocol::RecvDsdv ( Ptr< Socket socket)
private

Receive and process dsdv control packet.

Parameters
socketthe socket for receiving dsdv control packets

Definition at line 567 of file dsdv-routing-protocol.cc.

References ns3::dsdv::RoutingTable::AddIpv4Event(), ns3::dsdv::RoutingTable::AddRoute(), ns3::dsdv::RoutingTable::AnyRunningEvent(), ns3::Time::As(), ns3::InetSocketAddress::ConvertFrom(), ns3::dsdv::RoutingTable::DeleteRoute(), EnableRouteAggregation, ns3::dsdv::RoutingTable::ForceDeleteIpv4Event(), ns3::Timer::GetDelayLeft(), ns3::dsdv::DsdvHeader::GetDst(), ns3::dsdv::DsdvHeader::GetDstSeqno(), ns3::dsdv::RoutingTableEntry::GetHop(), ns3::dsdv::DsdvHeader::GetHopCount(), ns3::UniformRandomVariable::GetInteger(), ns3::InetSocketAddress::GetIpv4(), ns3::dsdv::RoutingTable::GetListOfAllRoutes(), ns3::dsdv::RoutingTable::GetListOfDestinationWithNextHop(), ns3::dsdv::RoutingTableEntry::GetNextHop(), ns3::dsdv::RoutingTableEntry::GetSeqNo(), GetSettlingTime(), ns3::Packet::GetSize(), ns3::EventId::GetUid(), ns3::Packet::GetUid(), ns3::dsdv::RoutingTable::LookupRoute(), m_advRoutingTable, m_ipv4, m_mainAddress, m_periodicUpdateTimer, m_routeAggregationTime, m_routingTable, m_settlingTime, m_socketAddresses, m_uniformRandomVariable, ns3::MicroSeconds(), ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_FUNCTION, packetSize, ns3::Socket::RecvFrom(), ns3::Packet::RemoveHeader(), ns3::Time::S, ns3::Simulator::Schedule(), SendTriggeredUpdate(), ns3::dsdv::RoutingTableEntry::SetEntriesChanged(), ns3::dsdv::RoutingTableEntry::SetFlag(), ns3::dsdv::RoutingTableEntry::SetHop(), ns3::dsdv::RoutingTableEntry::SetLifeTime(), ns3::dsdv::RoutingTableEntry::SetNextHop(), ns3::dsdv::RoutingTableEntry::SetSeqNo(), ns3::dsdv::RoutingTableEntry::SetSettlingTime(), ns3::dsdv::RoutingTable::Update(), and ns3::dsdv::VALID.

Referenced by NotifyAddAddress(), NotifyInterfaceUp(), and NotifyRemoveAddress().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ RouteInput()

◆ RouteOutput()

Ptr< Ipv4Route > ns3::dsdv::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()

The header input parameter may have an uninitialized value for the source address, but the destination address should always be properly set by the caller.

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

Implements ns3::Ipv4RoutingProtocol.

Definition at line 277 of file dsdv-routing-protocol.cc.

References ns3::Packet::AddPacketTag(), ns3::dsdv::RoutingTable::AddRoute(), EnableBuffering, ns3::Socket::ERROR_NOROUTETOHOST, ns3::Socket::ERROR_NOTERROR, ns3::Ipv4Header::GetDestination(), ns3::dsdv::RoutingTableEntry::GetHop(), ns3::UniformRandomVariable::GetInteger(), ns3::dsdv::RoutingTableEntry::GetNextHop(), ns3::dsdv::RoutingTableEntry::GetRoute(), ns3::Packet::GetSize(), ns3::Packet::GetUid(), LookForQueuedPackets(), ns3::dsdv::RoutingTable::LookupRoute(), LoopbackRoute(), m_advRoutingTable, m_ipv4, m_routingTable, m_socketAddresses, m_uniformRandomVariable, ns3::MicroSeconds(), NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::Packet::PeekPacketTag(), ns3::dsdv::RoutingTable::Purge(), ns3::Simulator::Schedule(), and SendTriggeredUpdate().

+ Here is the call graph for this function:

◆ Send()

void ns3::dsdv::RoutingProtocol::Send ( Ptr< Ipv4Route route,
Ptr< const Packet packet,
const Ipv4Header header 
)
private

Send a packet.

Parameters
routethe route
packetthe packet
headerthe IPv4 header

Definition at line 1119 of file dsdv-routing-protocol.cc.

References ns3::Packet::Copy(), ns3::Ipv4Header::GetDestination(), ns3::Ipv4Header::GetProtocol(), m_ipv4, and NS_ASSERT.

Referenced by Start().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SendPacketFromQueue()

void ns3::dsdv::RoutingProtocol::SendPacketFromQueue ( Ipv4Address  dst,
Ptr< Ipv4Route route 
)
private

◆ SendPeriodicUpdate()

◆ SendTriggeredUpdate()

◆ SetEnableBufferFlag()

void ns3::dsdv::RoutingProtocol::SetEnableBufferFlag ( bool  f)

Set enable buffer flag.

Parameters
fThe enable buffer flag

Definition at line 186 of file dsdv-routing-protocol.cc.

References EnableBuffering, and f().

Referenced by GetTypeId().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SetEnableRAFlag()

void ns3::dsdv::RoutingProtocol::SetEnableRAFlag ( bool  f)

Set enable route aggregation (RA) flag.

Parameters
fthe enable route aggregation (RA) flag

Definition at line 206 of file dsdv-routing-protocol.cc.

References EnableRouteAggregation, and f().

Referenced by GetTypeId().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SetIpv4()

void ns3::dsdv::RoutingProtocol::SetIpv4 ( Ptr< Ipv4 ipv4)
virtual
Parameters
ipv4the ipv4 object this routing protocol is being associated with

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

Implements ns3::Ipv4RoutingProtocol.

Definition at line 959 of file dsdv-routing-protocol.cc.

References ns3::dsdv::RoutingTable::AddRoute(), ns3::Ipv4Address::GetLoopback(), ns3::Simulator::GetMaximumSimulationTime(), ns3::dsdv::INVALID, m_ipv4, m_lo, m_routingTable, NS_ASSERT, ns3::Simulator::ScheduleNow(), ns3::dsdv::RoutingTableEntry::SetEntriesChanged(), ns3::dsdv::RoutingTableEntry::SetFlag(), and Start().

+ Here is the call graph for this function:

◆ SetWSTFlag()

void ns3::dsdv::RoutingProtocol::SetWSTFlag ( bool  f)

Set weighted settling time (WST) flag.

Parameters
fthe weighted settling time (WST) flag

Definition at line 196 of file dsdv-routing-protocol.cc.

References EnableWST, and f().

Referenced by GetTypeId().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ Start()

Member Data Documentation

◆ DSDV_PORT

const uint32_t ns3::dsdv::RoutingProtocol::DSDV_PORT = 269
static

UDP Port for DSDV control traffic.

Definition at line 61 of file dsdv-routing-protocol.h.

Referenced by NotifyAddAddress(), NotifyInterfaceUp(), NotifyRemoveAddress(), SendPeriodicUpdate(), and SendTriggeredUpdate().

◆ EnableBuffering

bool ns3::dsdv::RoutingProtocol::EnableBuffering
private

Flag that is used to enable or disable buffering.

Definition at line 167 of file dsdv-routing-protocol.h.

Referenced by GetEnableBufferFlag(), RouteInput(), RouteOutput(), and SetEnableBufferFlag().

◆ EnableRouteAggregation

bool ns3::dsdv::RoutingProtocol::EnableRouteAggregation
private

This is a flag to enable route aggregation.

Route aggregation will aggregate all routes for 'RouteAggregationTime' from the time an update is received by a node and sends them as a single update .

Definition at line 174 of file dsdv-routing-protocol.h.

Referenced by GetEnableRAFlag(), RecvDsdv(), and SetEnableRAFlag().

◆ EnableWST

bool ns3::dsdv::RoutingProtocol::EnableWST
private

Flag that is used to enable or disable Weighted Settling Time.

Definition at line 169 of file dsdv-routing-protocol.h.

Referenced by GetSettlingTime(), GetWSTFlag(), and SetWSTFlag().

◆ Holdtimes

uint32_t ns3::dsdv::RoutingProtocol::Holdtimes
private

Holdtimes is the multiplicative factor of PeriodicUpdateInterval for which the node waits since the last update before flushing a route from the routing table.

If PeriodicUpdateInterval is 8s and Holdtimes is 3, the node waits for 24s since the last update to flush this route from its routing table.

Definition at line 139 of file dsdv-routing-protocol.h.

Referenced by GetTypeId(), and Start().

◆ m_advRoutingTable

RoutingTable ns3::dsdv::RoutingProtocol::m_advRoutingTable
private

Advertised Routing table for the node.

Definition at line 157 of file dsdv-routing-protocol.h.

Referenced by MergeTriggerPeriodicUpdates(), NotifyInterfaceDown(), RecvDsdv(), RouteOutput(), SendTriggeredUpdate(), and Start().

◆ m_ecb

ErrorCallback ns3::dsdv::RoutingProtocol::m_ecb
private

Error callback for own packets.

Definition at line 180 of file dsdv-routing-protocol.h.

Referenced by Start().

◆ m_ipv4

◆ m_lo

Ptr<NetDevice> ns3::dsdv::RoutingProtocol::m_lo
private

Loopback device used to defer route requests until a route is found.

Definition at line 153 of file dsdv-routing-protocol.h.

Referenced by LoopbackRoute(), RouteInput(), and SetIpv4().

◆ m_mainAddress

Ipv4Address ns3::dsdv::RoutingProtocol::m_mainAddress
private

◆ m_maxQueuedPacketsPerDst

uint32_t ns3::dsdv::RoutingProtocol::m_maxQueuedPacketsPerDst
private

The maximum number of packets that we allow per destination to buffer.

Definition at line 161 of file dsdv-routing-protocol.h.

Referenced by GetTypeId(), and Start().

◆ m_maxQueueLen

uint32_t ns3::dsdv::RoutingProtocol::m_maxQueueLen
private

The maximum number of packets that we allow a routing protocol to buffer.

Definition at line 159 of file dsdv-routing-protocol.h.

Referenced by GetTypeId(), and Start().

◆ m_maxQueueTime

Time ns3::dsdv::RoutingProtocol::m_maxQueueTime
private

The maximum period of time that a routing protocol is allowed to buffer a packet for.

Definition at line 163 of file dsdv-routing-protocol.h.

Referenced by GetTypeId(), and Start().

◆ m_periodicUpdateInterval

Time ns3::dsdv::RoutingProtocol::m_periodicUpdateInterval
private

PeriodicUpdateInterval specifies the periodic time interval between which the a node broadcasts its entire routing table.

Definition at line 142 of file dsdv-routing-protocol.h.

Referenced by GetTypeId(), SendPeriodicUpdate(), and Start().

◆ m_periodicUpdateTimer

Timer ns3::dsdv::RoutingProtocol::m_periodicUpdateTimer
private

Timer to trigger periodic updates from a node.

Definition at line 263 of file dsdv-routing-protocol.h.

Referenced by RecvDsdv(), SendPeriodicUpdate(), and Start().

◆ m_queue

PacketQueue ns3::dsdv::RoutingProtocol::m_queue
private

A "drop front on full" queue used by the routing layer to buffer packets to which it does not have a route.

Definition at line 165 of file dsdv-routing-protocol.h.

Referenced by DeferredRouteOutput(), LookForQueuedPackets(), SendPacketFromQueue(), and Start().

◆ m_routeAggregationTime

Time ns3::dsdv::RoutingProtocol::m_routeAggregationTime
private

Parameter that holds the route aggregation time interval.

Definition at line 176 of file dsdv-routing-protocol.h.

Referenced by GetTypeId(), and RecvDsdv().

◆ m_routingTable

◆ m_scb

UnicastForwardCallback ns3::dsdv::RoutingProtocol::m_scb
private

Unicast callback for own packets.

Definition at line 178 of file dsdv-routing-protocol.h.

Referenced by Start().

◆ m_settlingTime

Time ns3::dsdv::RoutingProtocol::m_settlingTime
private

SettlingTime specifies the time for which a node waits before propagating an update.

It waits for this time interval in hope of receiving an update with a better metric.

Definition at line 145 of file dsdv-routing-protocol.h.

Referenced by GetTypeId(), and RecvDsdv().

◆ m_socketAddresses

std::map<Ptr<Socket>, Ipv4InterfaceAddress> ns3::dsdv::RoutingProtocol::m_socketAddresses
private

◆ m_triggeredExpireTimer

Timer ns3::dsdv::RoutingProtocol::m_triggeredExpireTimer
private

Timer used by the trigger updates in case of Weighted Settling Time is used.

Definition at line 265 of file dsdv-routing-protocol.h.

◆ m_uniformRandomVariable

Ptr<UniformRandomVariable> ns3::dsdv::RoutingProtocol::m_uniformRandomVariable
private

Provides uniform random variables.

Definition at line 268 of file dsdv-routing-protocol.h.

Referenced by RoutingProtocol(), AssignStreams(), RecvDsdv(), RouteOutput(), SendPacketFromQueue(), SendPeriodicUpdate(), and Start().

◆ m_weightedFactor

double ns3::dsdv::RoutingProtocol::m_weightedFactor
private

This is the wighted factor to determine the weighted settling time.

Definition at line 171 of file dsdv-routing-protocol.h.

Referenced by GetSettlingTime(), and GetTypeId().


The documentation for this class was generated from the following files: