A Discrete-Event Network Simulator
API
ns3::Rip Class Reference

RIP Routing Protocol, defined in RFC 2453. More...

#include "rip.h"

+ Inheritance diagram for ns3::Rip:
+ Collaboration diagram for ns3::Rip:

Public Types

enum  SplitHorizonType_e { NO_SPLIT_HORIZON, SPLIT_HORIZON, POISON_REVERSE }
 Split Horizon strategy type. More...
 
- 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_t > LocalDeliverCallback
 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...
 

Public Member Functions

 Rip ()
 
virtual ~Rip ()
 
void AddDefaultRouteTo (Ipv4Address nextHop, uint32_t interface)
 Add a default route to the router through the nextHop located on interface. More...
 
int64_t AssignStreams (int64_t stream)
 Assign a fixed random variable stream number to the random variables used by this model. More...
 
std::set< uint32_t > GetInterfaceExclusions () const
 Get the set of interface excluded from the protocol. More...
 
uint8_t GetInterfaceMetric (uint32_t interface) const
 Get the metric for an interface. 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 an input packet (to be forwarded or locally delivered) 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 SetInterfaceExclusions (std::set< uint32_t > exceptions)
 Set the set of interface excluded from the protocol. More...
 
void SetInterfaceMetric (uint32_t interface, uint8_t metric)
 Set the metric for an interface. More...
 
virtual void SetIpv4 (Ptr< Ipv4 > ipv4)
 
- 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<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. 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...
 
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...
 

Protected Member Functions

virtual void DoDispose ()
 Dispose this object. More...
 
void DoInitialize ()
 Start protocol operation. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. 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...
 

Private Types

typedef std::list< std::pair< RipRoutingTableEntry *, EventId > > Routes
 Container for the network routes - pair RipRoutingTableEntry *, EventId (update event) More...
 
typedef std::list< std::pair< RipRoutingTableEntry *, EventId > >::const_iterator RoutesCI
 Const Iterator for container for the network routes. More...
 
typedef std::list< std::pair< RipRoutingTableEntry *, EventId > >::iterator RoutesI
 Iterator for container for the network routes. More...
 
typedef std::map< Ptr< Socket >, uint32_t > SocketList
 Socket list type. More...
 
typedef std::map< Ptr< Socket >, uint32_t >::const_iterator SocketListCI
 Socket list type const iterator. More...
 
typedef std::map< Ptr< Socket >, uint32_t >::iterator SocketListI
 Socket list type iterator. More...
 

Private Member Functions

void AddNetworkRouteTo (Ipv4Address network, Ipv4Mask networkPrefix, Ipv4Address nextHop, uint32_t interface)
 Add route to network. More...
 
void AddNetworkRouteTo (Ipv4Address network, Ipv4Mask networkPrefix, uint32_t interface)
 Add route to network. More...
 
void DeleteRoute (RipRoutingTableEntry *route)
 Delete a route. More...
 
void DoSendRouteUpdate (bool periodic)
 Send Routing Updates on all interfaces. More...
 
void HandleRequests (RipHeader hdr, Ipv4Address senderAddress, uint16_t senderPort, uint32_t incomingInterface, uint8_t hopLimit)
 Handle RIP requests. More...
 
void HandleResponses (RipHeader hdr, Ipv4Address senderAddress, uint32_t incomingInterface, uint8_t hopLimit)
 Handle RIP responses. More...
 
void InvalidateRoute (RipRoutingTableEntry *route)
 Invalidate a route. More...
 
Ptr< Ipv4RouteLookup (Ipv4Address dest, Ptr< NetDevice >=0)
 Lookup in the forwarding table for destination. More...
 
void Receive (Ptr< Socket > socket)
 Receive RIP packets. More...
 
void RecvMulticastRip (Ptr< Socket > socket)
 Receive and process multicast packet. More...
 
void RecvUnicastRip (Ptr< Socket > socket)
 Receive and process unicast packet. More...
 
void SendRouteRequest ()
 Send Routing Request on all interfaces. More...
 
void SendTriggeredRouteUpdate ()
 Send Triggered Routing Updates on all interfaces. More...
 
void SendUnsolicitedRouteUpdate (void)
 Send Unsolicited Routing Updates on all interfaces. More...
 

Private Attributes

Time m_garbageCollectionDelay
 Delay before deleting an INVALID route. More...
 
bool m_initialized
 flag to allow socket's late-creation. More...
 
std::set< uint32_t > m_interfaceExclusions
 Set of excluded interfaces. More...
 
std::map< uint32_t, uint8_t > m_interfaceMetrics
 Map of interface metrics. More...
 
Ptr< Ipv4m_ipv4
 IPv4 reference. More...
 
uint32_t m_linkDown
 Link down value. More...
 
Time m_maxTriggeredUpdateDelay
 Max cooldown delay after a Triggered Update. More...
 
Time m_minTriggeredUpdateDelay
 Min cooldown delay after a Triggered Update. More...
 
Ptr< Socketm_multicastRecvSocket
 multicast receive socket More...
 
EventId m_nextTriggeredUpdate
 Next Triggered Update event. More...
 
EventId m_nextUnsolicitedUpdate
 Next Unsolicited Update event. More...
 
Ptr< UniformRandomVariablem_rng
 Rng stream. More...
 
Routes m_routes
 the forwarding table for network. More...
 
SplitHorizonType_e m_splitHorizonStrategy
 Split Horizon strategy. More...
 
Time m_startupDelay
 Random delay before protocol startup. More...
 
Time m_timeoutDelay
 Delay before invalidating a route. More...
 
SocketList m_unicastSocketList
 list of sockets for unicast messages (socket, interface index) More...
 
Time m_unsolicitedUpdate
 time between two Unsolicited Routing Updates More...
 

Additional Inherited Members

Detailed Description

RIP Routing Protocol, defined in RFC 2453.


Introspection did not find any typical Config paths.


Attributes

  • UnsolicitedRoutingUpdate: The time between two Unsolicited Routing Updates.
    • Set with class: ns3::TimeValue
    • Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
    • Initial value: +30000000000.0ns
    • Flags: construct write read
  • StartupDelay: Maximum random delay for protocol startup (send route requests).
    • Set with class: ns3::TimeValue
    • Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
    • Initial value: +1000000000.0ns
    • Flags: construct write read
  • TimeoutDelay: The delay to invalidate a route.
    • Set with class: ns3::TimeValue
    • Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
    • Initial value: +180000000000.0ns
    • Flags: construct write read
  • GarbageCollectionDelay: The delay to delete an expired route.
    • Set with class: ns3::TimeValue
    • Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
    • Initial value: +120000000000.0ns
    • Flags: construct write read
  • MinTriggeredCooldown: Min cooldown delay after a Triggered Update.
    • Set with class: ns3::TimeValue
    • Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
    • Initial value: +1000000000.0ns
    • Flags: construct write read
  • MaxTriggeredCooldown: Max cooldown delay after a Triggered Update.
    • Set with class: ns3::TimeValue
    • Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
    • Initial value: +5000000000.0ns
    • Flags: construct write read
  • SplitHorizon: Split Horizon strategy.
    • Set with class: ns3::EnumValue
    • Underlying type:
    • Initial value: PoisonReverse
    • Flags: construct write read
  • LinkDownValue: Value for link down in count to infinity.
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 0:4294967295
    • Initial value: 16
    • Flags: construct write read

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

Definition at line 173 of file rip.h.

Member Typedef Documentation

◆ Routes

typedef std::list<std::pair <RipRoutingTableEntry *, EventId> > ns3::Rip::Routes
private

Container for the network routes - pair RipRoutingTableEntry *, EventId (update event)

Definition at line 268 of file rip.h.

◆ RoutesCI

typedef std::list<std::pair <RipRoutingTableEntry *, EventId> >::const_iterator ns3::Rip::RoutesCI
private

Const Iterator for container for the network routes.

Definition at line 271 of file rip.h.

◆ RoutesI

typedef std::list<std::pair <RipRoutingTableEntry *, EventId> >::iterator ns3::Rip::RoutesI
private

Iterator for container for the network routes.

Definition at line 274 of file rip.h.

◆ SocketList

typedef std::map< Ptr<Socket>, uint32_t> ns3::Rip::SocketList
private

Socket list type.

Definition at line 386 of file rip.h.

◆ SocketListCI

typedef std::map<Ptr<Socket>, uint32_t>::const_iterator ns3::Rip::SocketListCI
private

Socket list type const iterator.

Definition at line 390 of file rip.h.

◆ SocketListI

typedef std::map<Ptr<Socket>, uint32_t>::iterator ns3::Rip::SocketListI
private

Socket list type iterator.

Definition at line 388 of file rip.h.

Member Enumeration Documentation

◆ SplitHorizonType_e

Split Horizon strategy type.

See RFC 2453.

Enumerator
NO_SPLIT_HORIZON 

No Split Horizon.

SPLIT_HORIZON 

Split Horizon.

POISON_REVERSE 

Poison Reverse Split Horizon.

Definition at line 202 of file rip.h.

Constructor & Destructor Documentation

◆ Rip()

ns3::Rip::Rip ( )

Definition at line 47 of file rip.cc.

References m_rng.

◆ ~Rip()

ns3::Rip::~Rip ( )
virtual

Definition at line 53 of file rip.cc.

Member Function Documentation

◆ AddDefaultRouteTo()

void ns3::Rip::AddDefaultRouteTo ( Ipv4Address  nextHop,
uint32_t  interface 
)

Add a default route to the router through the nextHop located on interface.

The default route is usually installed manually, or it is the result of some "other" routing protocol (e.g., BGP).

Parameters
nextHopthe next hop
interfacethe interface

Definition at line 1286 of file rip.cc.

References AddNetworkRouteTo(), ns3::Ipv4Mask::GetZero(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ AddNetworkRouteTo() [1/2]

void ns3::Rip::AddNetworkRouteTo ( Ipv4Address  network,
Ipv4Mask  networkPrefix,
Ipv4Address  nextHop,
uint32_t  interface 
)
private

Add route to network.

Parameters
networknetwork address
networkPrefixnetwork prefix
nextHopnext hop address to route the packet.
interfaceinterface index

Definition at line 653 of file rip.cc.

References m_routes, NS_LOG_FUNCTION, ns3::RipRoutingTableEntry::RIP_VALID, ns3::RipRoutingTableEntry::SetRouteChanged(), ns3::RipRoutingTableEntry::SetRouteMetric(), and ns3::RipRoutingTableEntry::SetRouteStatus().

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

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

◆ AddNetworkRouteTo() [2/2]

void ns3::Rip::AddNetworkRouteTo ( Ipv4Address  network,
Ipv4Mask  networkPrefix,
uint32_t  interface 
)
private

Add route to network.

Parameters
networknetwork address
networkPrefixnetwork prefix
interfaceinterface index

Definition at line 665 of file rip.cc.

References m_routes, NS_LOG_FUNCTION, ns3::RipRoutingTableEntry::RIP_VALID, ns3::RipRoutingTableEntry::SetRouteChanged(), ns3::RipRoutingTableEntry::SetRouteMetric(), and ns3::RipRoutingTableEntry::SetRouteStatus().

+ Here is the call graph for this function:

◆ AssignStreams()

int64_t ns3::Rip::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 102 of file rip.cc.

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

+ Here is the call graph for this function:

◆ DeleteRoute()

void ns3::Rip::DeleteRoute ( RipRoutingTableEntry route)
private

Delete a route.

Parameters
routethe route to be removed

Definition at line 699 of file rip.cc.

References m_routes, NS_ABORT_MSG, and NS_LOG_FUNCTION.

Referenced by InvalidateRoute().

+ Here is the caller graph for this function:

◆ DoDispose()

void ns3::Rip::DoDispose ( void  )
protectedvirtual

Dispose this object.

Reimplemented from ns3::Object.

Definition at line 549 of file rip.cc.

References ns3::EventId::Cancel(), ns3::Socket::Close(), ns3::Object::DoDispose(), m_ipv4, m_multicastRecvSocket, m_nextTriggeredUpdate, m_nextUnsolicitedUpdate, m_routes, m_unicastSocketList, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ DoInitialize()

◆ DoSendRouteUpdate()

◆ GetInterfaceExclusions()

std::set< uint32_t > ns3::Rip::GetInterfaceExclusions ( ) const

Get the set of interface excluded from the protocol.

Returns
the set of excluded interfaces

Definition at line 1219 of file rip.cc.

References m_interfaceExclusions.

◆ GetInterfaceMetric()

uint8_t ns3::Rip::GetInterfaceMetric ( uint32_t  interface) const

Get the metric for an interface.

Parameters
interfacethe interface
Returns
the interface metric

Definition at line 1231 of file rip.cc.

References m_interfaceMetrics, and NS_LOG_FUNCTION.

◆ GetTypeId()

◆ HandleRequests()

void ns3::Rip::HandleRequests ( RipHeader  hdr,
Ipv4Address  senderAddress,
uint16_t  senderPort,
uint32_t  incomingInterface,
uint8_t  hopLimit 
)
private

◆ HandleResponses()

void ns3::Rip::HandleResponses ( RipHeader  hdr,
Ipv4Address  senderAddress,
uint32_t  incomingInterface,
uint8_t  hopLimit 
)
private

Handle RIP responses.

Parameters
hdrmessage header (including RTEs)
senderAddresssender address
incomingInterfaceincoming interface
hopLimitpacket's hop limit

Definition at line 943 of file rip.cc.

References ns3::Ipv4Address::CombineMask(), ns3::Simulator::GetDelayLeft(), ns3::RipHeader::GetRteList(), InvalidateRoute(), m_interfaceExclusions, m_interfaceMetrics, m_linkDown, m_routes, m_timeoutDelay, NS_LOG_FUNCTION, NS_LOG_LOGIC(), ns3::RipRoutingTableEntry::RIP_VALID, ns3::Simulator::Schedule(), SendTriggeredRouteUpdate(), ns3::RipRoutingTableEntry::SetRouteChanged(), ns3::RipRoutingTableEntry::SetRouteMetric(), ns3::RipRoutingTableEntry::SetRouteStatus(), and ns3::RipRoutingTableEntry::SetRouteTag().

Referenced by Receive().

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

◆ InvalidateRoute()

void ns3::Rip::InvalidateRoute ( RipRoutingTableEntry route)
private

Invalidate a route.

Parameters
routethe route to be removed

Definition at line 677 of file rip.cc.

References DeleteRoute(), m_garbageCollectionDelay, m_linkDown, m_routes, NS_ABORT_MSG, NS_LOG_FUNCTION, ns3::RipRoutingTableEntry::RIP_INVALID, ns3::Simulator::Schedule(), ns3::RipRoutingTableEntry::SetRouteChanged(), ns3::RipRoutingTableEntry::SetRouteMetric(), and ns3::RipRoutingTableEntry::SetRouteStatus().

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

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

◆ Lookup()

◆ NotifyAddAddress()

void ns3::Rip::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 408 of file rip.cc.

References AddNetworkRouteTo(), first::address, ns3::Ipv4InterfaceAddress::GLOBAL, m_interfaceExclusions, m_ipv4, NS_LOG_FUNCTION, and SendTriggeredRouteUpdate().

+ Here is the call graph for this function:

◆ NotifyInterfaceDown()

void ns3::Rip::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 377 of file rip.cc.

References InvalidateRoute(), m_interfaceExclusions, m_routes, m_unicastSocketList, NS_LOG_FUNCTION, NS_LOG_INFO, and SendTriggeredRouteUpdate().

Referenced by SetIpv4().

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

◆ NotifyInterfaceUp()

void ns3::Rip::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 294 of file rip.cc.

References AddNetworkRouteTo(), first::address, ns3::Socket::Bind(), ns3::Socket::CreateSocket(), ns3::Ipv4InterfaceAddress::GLOBAL, ns3::Ipv4InterfaceAddress::HOST, ns3::TypeId::LookupByName(), m_initialized, m_interfaceExclusions, m_ipv4, m_multicastRecvSocket, m_unicastSocketList, ns3::MakeCallback(), NS_LOG_FUNCTION, NS_LOG_LOGIC(), Receive(), RIP_ALL_NODE, RIP_PORT, SendTriggeredRouteUpdate(), ns3::Socket::SetIpRecvTtl(), ns3::Socket::SetRecvCallback(), and ns3::Socket::SetRecvPktInfo().

Referenced by SetIpv4().

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

◆ NotifyRemoveAddress()

void ns3::Rip::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 433 of file rip.cc.

References first::address, ns3::Ipv4InterfaceAddress::GLOBAL, InvalidateRoute(), m_interfaceExclusions, m_ipv4, m_routes, NS_LOG_FUNCTION, and SendTriggeredRouteUpdate().

+ Here is the call graph for this function:

◆ PrintRoutingTable()

◆ Receive()

◆ RecvMulticastRip()

void ns3::Rip::RecvMulticastRip ( Ptr< Socket socket)
private

Receive and process multicast packet.

Parameters
socketsocket where packet is arrived

◆ RecvUnicastRip()

void ns3::Rip::RecvUnicastRip ( Ptr< Socket socket)
private

Receive and process unicast packet.

Parameters
socketsocket where packet is arrived

◆ RouteInput()

bool ns3::Rip::RouteInput ( Ptr< const Packet p,
const Ipv4Header header,
Ptr< const NetDevice idev,
UnicastForwardCallback  ucb,
MulticastForwardCallback  mcb,
LocalDeliverCallback  lcb,
ErrorCallback  ecb 
)
virtual

Route an input packet (to be forwarded or locally delivered)

This lookup is used in the forwarding process. The packet is handed over to the Ipv4RoutingProtocol, and will get forwarded onward by one of the callbacks. The Linux equivalent is ip_route_input(). There are four valid outcomes, and a matching callbacks to handle each.

Parameters
preceived packet
headerinput parameter used to form a search key for a route
idevPointer to ingress network device
ucbCallback for the case in which the packet is to be forwarded as unicast
mcbCallback for the case in which the packet is to be forwarded as multicast
lcbCallback for the case in which the packet is to be locally delivered
ecbCallback to call if there is an error in forwarding
Returns
true if the Ipv4RoutingProtocol takes responsibility for forwarding or delivering the packet, false otherwise

Implements ns3::Ipv4RoutingProtocol.

Definition at line 220 of file rip.cc.

References ns3::Socket::ERROR_NOROUTETOHOST, ns3::Ipv4Header::GetDestination(), ns3::Ipv4Header::GetSource(), ns3::Ipv4Address::IsBroadcast(), ns3::Ipv4Address::IsMulticast(), ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), Lookup(), m_ipv4, NS_ASSERT, NS_LOG_FUNCTION, and NS_LOG_LOGIC().

+ Here is the call graph for this function:

◆ RouteOutput()

Ptr< Ipv4Route > ns3::Rip::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 190 of file rip.cc.

References ns3::Socket::ERROR_NOROUTETOHOST, ns3::Socket::ERROR_NOTERROR, ns3::Ipv4Header::GetDestination(), ns3::Ipv4Address::IsMulticast(), Lookup(), NS_LOG_FUNCTION, and NS_LOG_LOGIC().

+ Here is the call graph for this function:

◆ SendRouteRequest()

◆ SendTriggeredRouteUpdate()

void ns3::Rip::SendTriggeredRouteUpdate ( )
private

◆ SendUnsolicitedRouteUpdate()

void ns3::Rip::SendUnsolicitedRouteUpdate ( void  )
private

Send Unsolicited Routing Updates on all interfaces.

Definition at line 1204 of file rip.cc.

References ns3::EventId::Cancel(), DoSendRouteUpdate(), ns3::Time::GetSeconds(), ns3::UniformRandomVariable::GetValue(), ns3::EventId::IsRunning(), m_nextTriggeredUpdate, m_nextUnsolicitedUpdate, m_rng, m_unsolicitedUpdate, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), and ns3::Seconds().

Referenced by DoInitialize().

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

◆ SetInterfaceExclusions()

void ns3::Rip::SetInterfaceExclusions ( std::set< uint32_t >  exceptions)

Set the set of interface excluded from the protocol.

Parameters
exceptionsthe set of excluded interfaces

Definition at line 1224 of file rip.cc.

References m_interfaceExclusions, and NS_LOG_FUNCTION.

◆ SetInterfaceMetric()

void ns3::Rip::SetInterfaceMetric ( uint32_t  interface,
uint8_t  metric 
)

Set the metric for an interface.

Parameters
interfacethe interface
metricthe interface metric

Definition at line 1243 of file rip.cc.

References m_interfaceMetrics, m_linkDown, and NS_LOG_FUNCTION.

◆ SetIpv4()

void ns3::Rip::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 470 of file rip.cc.

References m_ipv4, NotifyInterfaceDown(), NotifyInterfaceUp(), NS_ASSERT, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

Member Data Documentation

◆ m_garbageCollectionDelay

Time ns3::Rip::m_garbageCollectionDelay
private

Delay before deleting an INVALID route.

Definition at line 381 of file rip.h.

Referenced by GetTypeId(), and InvalidateRoute().

◆ m_initialized

bool ns3::Rip::m_initialized
private

flag to allow socket's late-creation.

Definition at line 405 of file rip.h.

Referenced by DoInitialize(), and NotifyInterfaceUp().

◆ m_interfaceExclusions

std::set<uint32_t> ns3::Rip::m_interfaceExclusions
private

◆ m_interfaceMetrics

std::map<uint32_t, uint8_t> ns3::Rip::m_interfaceMetrics
private

Map of interface metrics.

Definition at line 401 of file rip.h.

Referenced by GetInterfaceMetric(), HandleResponses(), and SetInterfaceMetric().

◆ m_ipv4

◆ m_linkDown

uint32_t ns3::Rip::m_linkDown
private

◆ m_maxTriggeredUpdateDelay

Time ns3::Rip::m_maxTriggeredUpdateDelay
private

Max cooldown delay after a Triggered Update.

Definition at line 378 of file rip.h.

Referenced by DoInitialize(), GetTypeId(), and SendTriggeredRouteUpdate().

◆ m_minTriggeredUpdateDelay

Time ns3::Rip::m_minTriggeredUpdateDelay
private

Min cooldown delay after a Triggered Update.

Definition at line 377 of file rip.h.

Referenced by DoInitialize(), GetTypeId(), and SendTriggeredRouteUpdate().

◆ m_multicastRecvSocket

Ptr<Socket> ns3::Rip::m_multicastRecvSocket
private

multicast receive socket

Definition at line 393 of file rip.h.

Referenced by DoDispose(), DoInitialize(), HandleRequests(), NotifyInterfaceUp(), and Receive().

◆ m_nextTriggeredUpdate

EventId ns3::Rip::m_nextTriggeredUpdate
private

Next Triggered Update event.

Definition at line 396 of file rip.h.

Referenced by DoDispose(), DoInitialize(), SendTriggeredRouteUpdate(), and SendUnsolicitedRouteUpdate().

◆ m_nextUnsolicitedUpdate

EventId ns3::Rip::m_nextUnsolicitedUpdate
private

Next Unsolicited Update event.

Definition at line 395 of file rip.h.

Referenced by DoDispose(), DoInitialize(), and SendUnsolicitedRouteUpdate().

◆ m_rng

Ptr<UniformRandomVariable> ns3::Rip::m_rng
private

Rng stream.

Definition at line 398 of file rip.h.

Referenced by AssignStreams(), DoInitialize(), Rip(), SendTriggeredRouteUpdate(), and SendUnsolicitedRouteUpdate().

◆ m_routes

Routes ns3::Rip::m_routes
private

◆ m_splitHorizonStrategy

SplitHorizonType_e ns3::Rip::m_splitHorizonStrategy
private

Split Horizon strategy.

Definition at line 403 of file rip.h.

Referenced by DoSendRouteUpdate(), GetTypeId(), and HandleRequests().

◆ m_startupDelay

Time ns3::Rip::m_startupDelay
private

Random delay before protocol startup.

Definition at line 376 of file rip.h.

Referenced by DoInitialize(), and GetTypeId().

◆ m_timeoutDelay

Time ns3::Rip::m_timeoutDelay
private

Delay before invalidating a route.

Definition at line 380 of file rip.h.

Referenced by GetTypeId(), and HandleResponses().

◆ m_unicastSocketList

SocketList ns3::Rip::m_unicastSocketList
private

list of sockets for unicast messages (socket, interface index)

Definition at line 392 of file rip.h.

Referenced by DoDispose(), DoInitialize(), DoSendRouteUpdate(), HandleRequests(), NotifyInterfaceDown(), NotifyInterfaceUp(), and SendRouteRequest().

◆ m_unsolicitedUpdate

Time ns3::Rip::m_unsolicitedUpdate
private

time between two Unsolicited Routing Updates

Definition at line 379 of file rip.h.

Referenced by DoInitialize(), GetTypeId(), and SendUnsolicitedRouteUpdate().


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