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

IPv4 list routing. More...

#include "ipv4-list-routing.h"

+ Inheritance diagram for ns3::Ipv4ListRouting:
+ Collaboration diagram for ns3::Ipv4ListRouting:

Public Member Functions

 Ipv4ListRouting ()
 
 ~Ipv4ListRouting () override
 
virtual void AddRoutingProtocol (Ptr< Ipv4RoutingProtocol > routingProtocol, int16_t priority)
 Register a new routing protocol to be used in this IPv4 stack. More...
 
virtual uint32_t GetNRoutingProtocols () const
 
virtual Ptr< Ipv4RoutingProtocolGetRoutingProtocol (uint32_t index, int16_t &priority) const
 Return pointer to routing protocol stored at index, with the first protocol (index 0) the highest priority, the next one (index 1) the second highest priority, and so on. More...
 
void NotifyAddAddress (uint32_t interface, Ipv4InterfaceAddress address) override
 
void NotifyInterfaceDown (uint32_t interface) override
 
void NotifyInterfaceUp (uint32_t interface) override
 
void NotifyRemoveAddress (uint32_t interface, Ipv4InterfaceAddress address) override
 
void PrintRoutingTable (Ptr< OutputStreamWrapper > stream, Time::Unit unit=Time::S) const override
 Print the Routing Table entries. More...
 
bool RouteInput (Ptr< const Packet > p, const Ipv4Header &header, Ptr< const NetDevice > idev, const UnicastForwardCallback &ucb, const MulticastForwardCallback &mcb, const LocalDeliverCallback &lcb, const ErrorCallback &ecb) override
 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) override
 Query routing cache for an existing route, for an outbound packet. More...
 
void SetIpv4 (Ptr< Ipv4 > ipv4) override
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
 ~Object () override
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose ()
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one. More...
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated 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...
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized () 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[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount () const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o[[maybe_unused]])
 Assignment operator. More...
 
void Ref () const
 Increment the reference count. More...
 
void Unref () 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 errors. 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 ()
 Get the type ID of this class. More...
 
- Static Public Member Functions inherited from ns3::Ipv4RoutingProtocol
static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID. More...
 

Protected Member Functions

void DoDispose () override
 Destructor implementation. More...
 
void DoInitialize () override
 Initialize() implementation. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void NotifyNewAggregate ()
 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 ()
 Notifier called once the ObjectBase is fully constructed. More...
 

Private Types

typedef std::pair< int16_t, Ptr< Ipv4RoutingProtocol > > Ipv4RoutingProtocolEntry
 Container identifying an IPv4 Routing Protocol entry in the list. More...
 
typedef std::list< Ipv4RoutingProtocolEntryIpv4RoutingProtocolList
 Container of the IPv4 Routing Protocols. More...
 

Static Private Member Functions

static bool Compare (const Ipv4RoutingProtocolEntry &a, const Ipv4RoutingProtocolEntry &b)
 Compare two routing protocols. More...
 

Private Attributes

Ptr< Ipv4m_ipv4
 Ipv4 this protocol is associated with. More...
 
Ipv4RoutingProtocolList m_routingProtocols
 List of routing protocols. 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_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...
 

Detailed Description

IPv4 list routing.

This class is a specialization of Ipv4RoutingProtocol that allows other instances of Ipv4RoutingProtocol to be inserted in a prioritized list. Routing protocols in the list are consulted one by one, from highest to lowest priority, until a routing protocol is found that will take the packet (this corresponds to a non-zero return value to RouteOutput, or a return value of true to RouteInput). The order by which routing protocols with the same priority value are consulted is undefined.

Definition at line 46 of file ipv4-list-routing.h.

Member Typedef Documentation

◆ Ipv4RoutingProtocolEntry

Container identifying an IPv4 Routing Protocol entry in the list.

Definition at line 112 of file ipv4-list-routing.h.

◆ Ipv4RoutingProtocolList

Container of the IPv4 Routing Protocols.

Definition at line 116 of file ipv4-list-routing.h.

Constructor & Destructor Documentation

◆ Ipv4ListRouting()

ns3::Ipv4ListRouting::Ipv4ListRouting ( )

Definition at line 44 of file ipv4-list-routing.cc.

References NS_LOG_FUNCTION.

◆ ~Ipv4ListRouting()

ns3::Ipv4ListRouting::~Ipv4ListRouting ( )
override

Definition at line 50 of file ipv4-list-routing.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ AddRoutingProtocol()

void ns3::Ipv4ListRouting::AddRoutingProtocol ( Ptr< Ipv4RoutingProtocol routingProtocol,
int16_t  priority 
)
virtual

Register a new routing protocol to be used in this IPv4 stack.

Parameters
routingProtocolnew routing protocol implementation object
prioritypriority to give to this routing protocol. Values may range between -32768 and +32767.

Definition at line 251 of file ipv4-list-routing.cc.

References Compare(), m_ipv4, m_routingProtocols, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ Compare()

bool ns3::Ipv4ListRouting::Compare ( const Ipv4RoutingProtocolEntry a,
const Ipv4RoutingProtocolEntry b 
)
staticprivate

Compare two routing protocols.

Parameters
afirst object to compare
bsecond object to compare
Returns
true if they are the same, false otherwise

Definition at line 292 of file ipv4-list-routing.cc.

References NS_LOG_FUNCTION.

Referenced by AddRoutingProtocol().

+ Here is the caller graph for this function:

◆ DoDispose()

void ns3::Ipv4ListRouting::DoDispose ( void  )
overrideprotectedvirtual

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 56 of file ipv4-list-routing.cc.

References m_ipv4, m_routingProtocols, and NS_LOG_FUNCTION.

◆ DoInitialize()

void ns3::Ipv4ListRouting::DoInitialize ( void  )
overrideprotectedvirtual

Initialize() implementation.

This method is called only once by Initialize(). If the user calls Initialize() multiple times, DoInitialize() is called only the first time.

Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject() and AggregateObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 88 of file ipv4-list-routing.cc.

References ns3::Object::DoInitialize(), m_routingProtocols, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ GetNRoutingProtocols()

uint32_t ns3::Ipv4ListRouting::GetNRoutingProtocols ( ) const
virtual
Returns
number of routing protocols in the list

Definition at line 263 of file ipv4-list-routing.cc.

References m_routingProtocols, and NS_LOG_FUNCTION.

◆ GetRoutingProtocol()

Ptr< Ipv4RoutingProtocol > ns3::Ipv4ListRouting::GetRoutingProtocol ( uint32_t  index,
int16_t &  priority 
) const
virtual

Return pointer to routing protocol stored at index, with the first protocol (index 0) the highest priority, the next one (index 1) the second highest priority, and so on.

The priority parameter is an output parameter and it returns the integer priority of the protocol.

Returns
pointer to routing protocol indexed by
Parameters
indexindex of protocol to return
priorityoutput parameter, set to the priority of the protocol being returned

Definition at line 270 of file ipv4-list-routing.cc.

References m_routingProtocols, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

◆ GetTypeId()

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

Get the type ID of this class.

Returns
type ID

Definition at line 35 of file ipv4-list-routing.cc.

References ns3::TypeId::SetParent().

Referenced by RouteOutput().

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

◆ NotifyAddAddress()

void ns3::Ipv4ListRouting::NotifyAddAddress ( uint32_t  interface,
Ipv4InterfaceAddress  address 
)
overridevirtual
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 216 of file ipv4-list-routing.cc.

References first::address, m_routingProtocols, and NS_LOG_FUNCTION.

◆ NotifyInterfaceDown()

void ns3::Ipv4ListRouting::NotifyInterfaceDown ( uint32_t  interface)
overridevirtual
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 205 of file ipv4-list-routing.cc.

References m_routingProtocols, and NS_LOG_FUNCTION.

◆ NotifyInterfaceUp()

void ns3::Ipv4ListRouting::NotifyInterfaceUp ( uint32_t  interface)
overridevirtual
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 194 of file ipv4-list-routing.cc.

References m_routingProtocols, and NS_LOG_FUNCTION.

◆ NotifyRemoveAddress()

void ns3::Ipv4ListRouting::NotifyRemoveAddress ( uint32_t  interface,
Ipv4InterfaceAddress  address 
)
overridevirtual
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 227 of file ipv4-list-routing.cc.

References first::address, m_routingProtocols, and NS_LOG_FUNCTION.

◆ PrintRoutingTable()

void ns3::Ipv4ListRouting::PrintRoutingTable ( Ptr< OutputStreamWrapper stream,
Time::Unit  unit = Time::S 
) const
overridevirtual

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 72 of file ipv4-list-routing.cc.

References ns3::Time::As(), ns3::OutputStreamWrapper::GetStream(), m_ipv4, m_routingProtocols, ns3::Now(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ RouteInput()

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

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 130 of file ipv4-list-routing.cc.

References ns3::Packet::Copy(), ns3::Socket::ERROR_NOROUTETOHOST, ns3::Ipv4Header::GetDestination(), ns3::Node::GetId(), ns3::Ipv4Address::IsMulticast(), m_ipv4, m_routingProtocols, NS_ASSERT, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

+ Here is the call graph for this function:

◆ RouteOutput()

Ptr< Ipv4Route > ns3::Ipv4ListRouting::RouteOutput ( Ptr< Packet p,
const Ipv4Header header,
Ptr< NetDevice oif,
Socket::SocketErrno sockerr 
)
overridevirtual

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 101 of file ipv4-list-routing.cc.

References ns3::Socket::ERROR_NOROUTETOHOST, ns3::Socket::ERROR_NOTERROR, ns3::Ipv4Header::GetDestination(), ns3::Ipv4Header::GetSource(), GetTypeId(), m_routingProtocols, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

+ Here is the call graph for this function:

◆ SetIpv4()

void ns3::Ipv4ListRouting::SetIpv4 ( Ptr< Ipv4 ipv4)
overridevirtual
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 238 of file ipv4-list-routing.cc.

References nsclick-simple-lan::ipv4, m_ipv4, m_routingProtocols, NS_ASSERT, and NS_LOG_FUNCTION.

Member Data Documentation

◆ m_ipv4

Ptr<Ipv4> ns3::Ipv4ListRouting::m_ipv4
private

Ipv4 this protocol is associated with.

Definition at line 126 of file ipv4-list-routing.h.

Referenced by AddRoutingProtocol(), DoDispose(), PrintRoutingTable(), RouteInput(), and SetIpv4().

◆ m_routingProtocols


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