A Discrete-Event Network Simulator
API
ns3::Ipv4RoutingProtocol Class Referenceabstract

Abstract base class for IPv4 routing protocols. More...

#include "ipv4-routing-protocol.h"

+ Inheritance diagram for ns3::Ipv4RoutingProtocol:
+ Collaboration diagram for ns3::Ipv4RoutingProtocol:

Public Types

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

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<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...
 
template<>
Ptr< ObjectGetObject () const
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 
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::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...
 

Additional Inherited Members

- 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

Abstract base class for IPv4 routing protocols.


Introspection did not find any typical Config paths.

Defines two virtual functions for packet routing and forwarding. The first, RouteOutput(), is used for locally originated packets, and the second, RouteInput(), is used for forwarding and/or delivering received packets. Also defines the signatures of four callbacks used in RouteInput().


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

Definition at line 56 of file ipv4-routing-protocol.h.

Member Typedef Documentation

◆ ErrorCallback

Callback for routing errors (e.g., no route found)

Definition at line 75 of file ipv4-routing-protocol.h.

◆ LocalDeliverCallback

Callback for packets to be locally delivered.

Definition at line 72 of file ipv4-routing-protocol.h.

◆ MulticastForwardCallback

Callback for multicast packets to be forwarded.

Definition at line 69 of file ipv4-routing-protocol.h.

◆ UnicastForwardCallback

Callback for unicast packets to be forwarded.

Definition at line 66 of file ipv4-routing-protocol.h.

Member Function Documentation

◆ GetTypeId()

TypeId ns3::Ipv4RoutingProtocol::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

Definition at line 30 of file ipv4-routing-protocol.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ NotifyAddAddress()

virtual void ns3::Ipv4RoutingProtocol::NotifyAddAddress ( uint32_t  interface,
Ipv4InterfaceAddress  address 
)
pure 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.

Implemented in ns3::olsr::RoutingProtocol, ns3::Ipv4NixVectorRouting, ns3::Rip, ns3::Ipv4GlobalRouting, ns3::Ipv4ListRouting, ns3::dsdv::RoutingProtocol, ns3::Ipv4StaticRouting, ns3::aodv::RoutingProtocol, Ipv4BRouting, and Ipv4ARouting.

◆ NotifyInterfaceDown()

virtual void ns3::Ipv4RoutingProtocol::NotifyInterfaceDown ( uint32_t  interface)
pure 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.

Implemented in ns3::olsr::RoutingProtocol, ns3::Ipv4NixVectorRouting, ns3::Rip, ns3::Ipv4GlobalRouting, ns3::Ipv4ListRouting, ns3::dsdv::RoutingProtocol, ns3::Ipv4StaticRouting, ns3::aodv::RoutingProtocol, Ipv4BRouting, and Ipv4ARouting.

◆ NotifyInterfaceUp()

virtual void ns3::Ipv4RoutingProtocol::NotifyInterfaceUp ( uint32_t  interface)
pure 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.

Implemented in ns3::olsr::RoutingProtocol, ns3::Ipv4NixVectorRouting, ns3::Rip, ns3::Ipv4GlobalRouting, ns3::Ipv4ListRouting, ns3::dsdv::RoutingProtocol, ns3::Ipv4StaticRouting, ns3::aodv::RoutingProtocol, Ipv4BRouting, and Ipv4ARouting.

◆ NotifyRemoveAddress()

virtual void ns3::Ipv4RoutingProtocol::NotifyRemoveAddress ( uint32_t  interface,
Ipv4InterfaceAddress  address 
)
pure 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.

Implemented in ns3::olsr::RoutingProtocol, ns3::Ipv4NixVectorRouting, ns3::Rip, ns3::Ipv4GlobalRouting, ns3::Ipv4ListRouting, ns3::dsdv::RoutingProtocol, ns3::Ipv4StaticRouting, ns3::aodv::RoutingProtocol, Ipv4BRouting, and Ipv4ARouting.

◆ PrintRoutingTable()

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

Print the Routing Table entries.

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

Implemented in ns3::olsr::RoutingProtocol, ns3::Ipv4NixVectorRouting, ns3::Rip, ns3::Ipv4GlobalRouting, ns3::Ipv4ListRouting, ns3::Ipv4StaticRouting, ns3::dsdv::RoutingProtocol, ns3::aodv::RoutingProtocol, Ipv4BRouting, and Ipv4ARouting.

◆ RouteInput()

virtual bool ns3::Ipv4RoutingProtocol::RouteInput ( Ptr< const Packet p,
const Ipv4Header header,
Ptr< const NetDevice idev,
UnicastForwardCallback  ucb,
MulticastForwardCallback  mcb,
LocalDeliverCallback  lcb,
ErrorCallback  ecb 
)
pure 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

Implemented in ns3::olsr::RoutingProtocol, ns3::Ipv4NixVectorRouting, ns3::Rip, ns3::Ipv4GlobalRouting, ns3::Ipv4ListRouting, ns3::Ipv4StaticRouting, ns3::aodv::RoutingProtocol, Ipv4BRouting, and Ipv4ARouting.

◆ RouteOutput()

virtual Ptr<Ipv4Route> ns3::Ipv4RoutingProtocol::RouteOutput ( Ptr< Packet p,
const Ipv4Header header,
Ptr< NetDevice oif,
Socket::SocketErrno sockerr 
)
pure 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

Implemented in ns3::olsr::RoutingProtocol, ns3::Ipv4NixVectorRouting, ns3::Rip, ns3::Ipv4GlobalRouting, ns3::Ipv4ListRouting, ns3::Ipv4StaticRouting, ns3::aodv::RoutingProtocol, ns3::dsdv::RoutingProtocol, Ipv4BRouting, and Ipv4ARouting.

◆ SetIpv4()

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

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

Implemented in ns3::olsr::RoutingProtocol, ns3::Ipv4NixVectorRouting, ns3::Rip, ns3::Ipv4GlobalRouting, ns3::Ipv4ListRouting, ns3::dsdv::RoutingProtocol, ns3::Ipv4StaticRouting, ns3::aodv::RoutingProtocol, Ipv4BRouting, and Ipv4ARouting.


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