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

Hold list of Ipv6RoutingProtocol objects. More...

#include "ipv6-list-routing.h"

+ Inheritance diagram for ns3::Ipv6ListRouting:
+ Collaboration diagram for ns3::Ipv6ListRouting:

Public Member Functions

 Ipv6ListRouting ()
 Constructor. More...
 
virtual ~Ipv6ListRouting ()
 Destructor. More...
 
virtual void AddRoutingProtocol (Ptr< Ipv6RoutingProtocol > routingProtocol, int16_t priority)
 Register a new routing protocol to be used in this IPv4 stack. More...
 
virtual uint32_t GetNRoutingProtocols (void) const
 Get the number of routing protocols. More...
 
virtual Ptr< Ipv6RoutingProtocolGetRoutingProtocol (uint32_t index, int16_t &priority) const
 Get pointer to routing protocol stored at index,. More...
 
virtual void NotifyAddAddress (uint32_t interface, Ipv6InterfaceAddress address)
 Notify when specified interface add an address. More...
 
virtual void NotifyAddRoute (Ipv6Address dst, Ipv6Prefix mask, Ipv6Address nextHop, uint32_t interface, Ipv6Address prefixToUse=Ipv6Address::GetZero())
 Notify a new route. More...
 
virtual void NotifyInterfaceDown (uint32_t interface)
 Notify when specified interface goes DOWN. More...
 
virtual void NotifyInterfaceUp (uint32_t interface)
 Notify when specified interface goes UP. More...
 
virtual void NotifyRemoveAddress (uint32_t interface, Ipv6InterfaceAddress address)
 Notify when specified interface add an address. More...
 
virtual void NotifyRemoveRoute (Ipv6Address dst, Ipv6Prefix mask, Ipv6Address nextHop, uint32_t interface, Ipv6Address prefixToUse=Ipv6Address::GetZero())
 Notify route removing. More...
 
virtual void PrintRoutingTable (Ptr< OutputStreamWrapper > stream, Time::Unit unit=Time::S) const
 Print the Routing Table entries. More...
 
virtual bool RouteInput (Ptr< const Packet > p, const Ipv6Header &header, Ptr< const NetDevice > idev, UnicastForwardCallback ucb, MulticastForwardCallback mcb, LocalDeliverCallback lcb, ErrorCallback ecb)
 Route an input packet (to be forwarded or locally delivered) More...
 
virtual Ptr< Ipv6RouteRouteOutput (Ptr< Packet > p, const Ipv6Header &header, Ptr< NetDevice > oif, Socket::SocketErrno &sockerr)
 Query routing cache for an existing route, for an outbound packet. More...
 
virtual void SetIpv6 (Ptr< Ipv6 > ipv6)
 Typically, invoked directly or indirectly from ns3::Ipv6::SetRoutingProtocol. More...
 
- 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[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= ([[maybe_unused]] 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 of this class. More...
 
- Static Public Member Functions inherited from ns3::Ipv6RoutingProtocol
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 (void)
 Dispose this object. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. 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...
 

Private Types

typedef std::pair< int16_t, Ptr< Ipv6RoutingProtocol > > Ipv6RoutingProtocolEntry
 Container identifying an IPv6 Routing Protocol entry in the list. More...
 
typedef std::list< Ipv6RoutingProtocolEntryIpv6RoutingProtocolList
 Container of the IPv6 Routing Protocols. More...
 

Static Private Member Functions

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

Private Attributes

Ptr< Ipv6m_ipv6
 Ipv6 this protocol is associated with. More...
 
Ipv6RoutingProtocolList m_routingProtocols
 List of routing protocols. More...
 

Additional Inherited Members

- Public Types inherited from ns3::Ipv6RoutingProtocol
typedef Callback< void, Ptr< const Packet >, const Ipv6Header &, Socket::SocketErrnoErrorCallback
 Callback for routing errors (e.g., no route found) More...
 
typedef Callback< void, Ptr< const Packet >, const Ipv6Header &, uint32_t > LocalDeliverCallback
 Callback for packets to be locally delivered. More...
 
typedef Callback< void, Ptr< const NetDevice >, Ptr< Ipv6MulticastRoute >, Ptr< const Packet >, const Ipv6Header & > MulticastForwardCallback
 Callback for multicast packets to be forwarded. More...
 
typedef Callback< void, Ptr< const NetDevice >, Ptr< Ipv6Route >, Ptr< const Packet >, const Ipv6Header & > UnicastForwardCallback
 Callback for unicast packets to be forwarded. More...
 

Detailed Description

Hold list of Ipv6RoutingProtocol objects.

Introspection did not find any typical Config paths.

This class is a specialization of Ipv6RoutingProtocol that allows other instances of Ipv6RoutingProtocol 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.


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

Definition at line 42 of file ipv6-list-routing.h.

Member Typedef Documentation

◆ Ipv6RoutingProtocolEntry

Container identifying an IPv6 Routing Protocol entry in the list.

Definition at line 113 of file ipv6-list-routing.h.

◆ Ipv6RoutingProtocolList

Container of the IPv6 Routing Protocols.

Definition at line 118 of file ipv6-list-routing.h.

Constructor & Destructor Documentation

◆ Ipv6ListRouting()

ns3::Ipv6ListRouting::Ipv6ListRouting ( )

Constructor.

Definition at line 46 of file ipv6-list-routing.cc.

References NS_LOG_FUNCTION.

◆ ~Ipv6ListRouting()

ns3::Ipv6ListRouting::~Ipv6ListRouting ( )
virtual

Destructor.

Definition at line 52 of file ipv6-list-routing.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ AddRoutingProtocol()

void ns3::Ipv6ListRouting::AddRoutingProtocol ( Ptr< Ipv6RoutingProtocol 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 245 of file ipv6-list-routing.cc.

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

+ Here is the call graph for this function:

◆ Compare()

bool ns3::Ipv6ListRouting::Compare ( const Ipv6RoutingProtocolEntry a,
const Ipv6RoutingProtocolEntry 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 285 of file ipv6-list-routing.cc.

Referenced by AddRoutingProtocol().

+ Here is the caller graph for this function:

◆ DoDispose()

void ns3::Ipv6ListRouting::DoDispose ( void  )
protectedvirtual

Dispose this object.

Reimplemented from ns3::Object.

Definition at line 58 of file ipv6-list-routing.cc.

References m_ipv6, m_routingProtocols, and NS_LOG_FUNCTION.

◆ GetNRoutingProtocols()

uint32_t ns3::Ipv6ListRouting::GetNRoutingProtocols ( void  ) const
virtual

Get the number of routing protocols.

Returns
number of routing protocols in the list

Definition at line 257 of file ipv6-list-routing.cc.

References m_routingProtocols, and NS_LOG_FUNCTION.

◆ GetRoutingProtocol()

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

Get pointer to routing protocol stored at index,.

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.

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

Definition at line 264 of file ipv6-list-routing.cc.

References m_routingProtocols, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

◆ GetTypeId()

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

Get the type ID of this class.

Returns
type ID

Definition at line 35 of file ipv6-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::Ipv6ListRouting::NotifyAddAddress ( uint32_t  interface,
Ipv6InterfaceAddress  address 
)
virtual

Notify when specified interface add an address.

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.

Parameters
interfacethe index of the interface we are being notified about
addressa new address being added to an interface

Implements ns3::Ipv6RoutingProtocol.

Definition at line 164 of file ipv6-list-routing.cc.

References first::address, m_routingProtocols, and NS_LOG_FUNCTION.

◆ NotifyAddRoute()

void ns3::Ipv6ListRouting::NotifyAddRoute ( Ipv6Address  dst,
Ipv6Prefix  mask,
Ipv6Address  nextHop,
uint32_t  interface,
Ipv6Address  prefixToUse = Ipv6Address::GetZero() 
)
virtual

Notify a new route.

Typically this is used to add another route from IPv6 stack (i.e. ICMPv6 redirect case, ...).

Parameters
dstdestination address
maskdestination mask
nextHopnextHop for this destination
interfaceoutput interface
prefixToUseprefix to use as source with this route

Implements ns3::Ipv6RoutingProtocol.

Definition at line 188 of file ipv6-list-routing.cc.

References m_routingProtocols, and NS_LOG_FUNCTION.

◆ NotifyInterfaceDown()

void ns3::Ipv6ListRouting::NotifyInterfaceDown ( uint32_t  interface)
virtual

Notify when specified interface goes DOWN.

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

Parameters
interfacethe index of the interface we are being notified about

Implements ns3::Ipv6RoutingProtocol.

Definition at line 152 of file ipv6-list-routing.cc.

References m_routingProtocols, and NS_LOG_FUNCTION.

◆ NotifyInterfaceUp()

void ns3::Ipv6ListRouting::NotifyInterfaceUp ( uint32_t  interface)
virtual

Notify when specified interface goes UP.

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

Parameters
interfacethe index of the interface we are being notified about

Implements ns3::Ipv6RoutingProtocol.

Definition at line 140 of file ipv6-list-routing.cc.

References m_routingProtocols, and NS_LOG_FUNCTION.

◆ NotifyRemoveAddress()

void ns3::Ipv6ListRouting::NotifyRemoveAddress ( uint32_t  interface,
Ipv6InterfaceAddress  address 
)
virtual

Notify when specified interface add an address.

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.

Parameters
interfacethe index of the interface we are being notified about
addressa new address being added to an interface

Implements ns3::Ipv6RoutingProtocol.

Definition at line 176 of file ipv6-list-routing.cc.

References first::address, m_routingProtocols, and NS_LOG_FUNCTION.

◆ NotifyRemoveRoute()

void ns3::Ipv6ListRouting::NotifyRemoveRoute ( Ipv6Address  dst,
Ipv6Prefix  mask,
Ipv6Address  nextHop,
uint32_t  interface,
Ipv6Address  prefixToUse = Ipv6Address::GetZero() 
)
virtual

Notify route removing.

Parameters
dstdestination address
maskdestination mask
nextHopnextHop for this destination
interfaceoutput interface
prefixToUseprefix to use as source with this route

Implements ns3::Ipv6RoutingProtocol.

Definition at line 200 of file ipv6-list-routing.cc.

References m_routingProtocols, and NS_LOG_FUNCTION.

◆ PrintRoutingTable()

void ns3::Ipv6ListRouting::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::Ipv6RoutingProtocol.

Definition at line 213 of file ipv6-list-routing.cc.

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

+ Here is the call graph for this function:

◆ RouteInput()

bool ns3::Ipv6ListRouting::RouteInput ( Ptr< const Packet p,
const Ipv6Header 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 Ipv6RoutingProtocol, 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 Ipv6RoutingProtocol takes responsibility for forwarding or delivering the packet, false otherwise

Implements ns3::Ipv6RoutingProtocol.

Definition at line 100 of file ipv6-list-routing.cc.

References ns3::Socket::ERROR_NOROUTETOHOST, ns3::Ipv6Header::GetDestination(), ns3::Node::GetId(), m_ipv6, m_routingProtocols, NS_ASSERT, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

+ Here is the call graph for this function:

◆ RouteOutput()

Ptr< Ipv6Route > ns3::Ipv6ListRouting::RouteOutput ( Ptr< Packet p,
const Ipv6Header header,
Ptr< NetDevice oif,
Socket::SocketErrno sockerr 
)
virtual

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

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

Parameters
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 device. 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::Ipv6RoutingProtocol.

Definition at line 74 of file ipv6-list-routing.cc.

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

+ Here is the call graph for this function:

◆ SetIpv6()

void ns3::Ipv6ListRouting::SetIpv6 ( Ptr< Ipv6 ipv6)
virtual

Typically, invoked directly or indirectly from ns3::Ipv6::SetRoutingProtocol.

Parameters
ipv6the ipv6 object this routing protocol is being associated with

Implements ns3::Ipv6RoutingProtocol.

Definition at line 230 of file ipv6-list-routing.cc.

References m_ipv6, m_routingProtocols, NS_ASSERT, and NS_LOG_FUNCTION.

Member Data Documentation

◆ m_ipv6

Ptr<Ipv6> ns3::Ipv6ListRouting::m_ipv6
private

Ipv6 this protocol is associated with.

Definition at line 129 of file ipv6-list-routing.h.

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

◆ m_routingProtocols


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