Static routing protocol for IP version 6 stacks. More...

#include "ipv6-static-routing.h"

Inheritance diagram for ns3::Ipv6StaticRouting:

Collaboration diagram for ns3::Ipv6StaticRouting:

Public Member Functions
	Ipv6StaticRouting ()

	~Ipv6StaticRouting () override

void	AddHostRouteTo (Ipv6Address dest, Ipv6Address nextHop, uint32_t interface, Ipv6Address prefixToUse=Ipv6Address("::"), uint32_t metric=0)
	Add route to host. More...

void	AddHostRouteTo (Ipv6Address dest, uint32_t interface, uint32_t metric=0)
	Add route to host. More...

void	AddMulticastRoute (Ipv6Address origin, Ipv6Address group, uint32_t inputInterface, std::vector< uint32_t > outputInterfaces)
	Add a multicast route for a given multicast source and group. More...

void	AddNetworkRouteTo (Ipv6Address network, Ipv6Prefix networkPrefix, Ipv6Address nextHop, uint32_t interface, Ipv6Address prefixToUse, uint32_t metric=0)
	Add route to network. More...

void	AddNetworkRouteTo (Ipv6Address network, Ipv6Prefix networkPrefix, Ipv6Address nextHop, uint32_t interface, uint32_t metric=0)
	Add route to network. More...

void	AddNetworkRouteTo (Ipv6Address network, Ipv6Prefix networkPrefix, uint32_t interface, uint32_t metric=0)
	Add route to network. More...

Ipv6RoutingTableEntry	GetDefaultRoute ()
	Get the default route. More...

uint32_t	GetMetric (uint32_t index) const
	Get a metric for route from the static unicast routing table. More...

Ipv6MulticastRoutingTableEntry	GetMulticastRoute (uint32_t i) const
	Get the specified multicast route. More...

uint32_t	GetNMulticastRoutes () const
	Get the number of entries in the multicast routing table. More...

uint32_t	GetNRoutes () const
	Get the number or entries in the routing table. More...

Ipv6RoutingTableEntry	GetRoute (uint32_t i) const
	Get a specified route. More...

bool	HasNetworkDest (Ipv6Address dest, uint32_t interfaceIndex)
	If the destination is already present in network destination list. More...

void	NotifyAddAddress (uint32_t interface, Ipv6InterfaceAddress address) override
	Notify when specified interface add an address. More...

void	NotifyAddRoute (Ipv6Address dst, Ipv6Prefix mask, Ipv6Address nextHop, uint32_t interface, Ipv6Address prefixToUse=Ipv6Address::GetZero()) override
	Notify a new route. More...

void	NotifyInterfaceDown (uint32_t interface) override
	Notify when specified interface goes DOWN. More...

void	NotifyInterfaceUp (uint32_t interface) override
	Notify when specified interface goes UP. More...

void	NotifyRemoveAddress (uint32_t interface, Ipv6InterfaceAddress address) override
	Notify when specified interface add an address. More...

void	NotifyRemoveRoute (Ipv6Address dst, Ipv6Prefix mask, Ipv6Address nextHop, uint32_t interface, Ipv6Address prefixToUse=Ipv6Address::GetZero()) override
	Notify route removing. More...

void	PrintRoutingTable (Ptr< OutputStreamWrapper > stream, Time::Unit unit=Time::S) const override
	Print the Routing Table entries. More...

bool	RemoveMulticastRoute (Ipv6Address origin, Ipv6Address group, uint32_t inputInterface)
	Remove a static multicast route. More...

void	RemoveMulticastRoute (uint32_t i)
	Remove a multicast route. More...

void	RemoveRoute (Ipv6Address network, Ipv6Prefix prefix, uint32_t ifIndex, Ipv6Address prefixToUse)
	Remove a route from the routing table. More...

void	RemoveRoute (uint32_t i)
	Remove a route from the routing table. More...

bool	RouteInput (Ptr< const Packet > p, const Ipv6Header &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< Ipv6Route >	RouteOutput (Ptr< Packet > p, const Ipv6Header &header, Ptr< NetDevice > oif, Socket::SocketErrno &sockerr) override
	Query routing cache for an existing route, for an outbound packet. More...

void	SetDefaultMulticastRoute (uint32_t outputInterface)
	Set the default multicast route. More...

void	SetDefaultRoute (Ipv6Address nextHop, uint32_t interface, Ipv6Address prefixToUse=Ipv6Address("::"), uint32_t metric=0)
	Set the default route. More...

void	SetIpv6 (Ptr< Ipv6 > ipv6) override
	Typically, invoked directly or indirectly from ns3::Ipv6::SetRoutingProtocol. More...

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< Object >	GetObject () 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< Object >	GetObject (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...

SimpleRefCount &	operator= (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 ()
	The interface Id associated with this class. More...

Static Public Member Functions inherited from ns3::Ipv6RoutingProtocol
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
	Dispose this object. More...

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object. More...

virtual void	DoInitialize ()
	Initialize() implementation. 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::list< Ipv6MulticastRoutingTableEntry * >	MulticastRoutes
	Container for the multicast routes. More...

typedef std::list< Ipv6MulticastRoutingTableEntry * >::const_iterator	MulticastRoutesCI
	Const Iterator for container for the multicast routes. More...

typedef std::list< Ipv6MulticastRoutingTableEntry * >::iterator	MulticastRoutesI
	Iterator for container for the multicast routes. More...

typedef std::list< std::pair< Ipv6RoutingTableEntry *, uint32_t > >	NetworkRoutes
	Container for the network routes. More...

typedef std::list< std::pair< Ipv6RoutingTableEntry *, uint32_t > >::const_iterator	NetworkRoutesCI
	Const Iterator for container for the network routes. More...

typedef std::list< std::pair< Ipv6RoutingTableEntry *, uint32_t > >::iterator	NetworkRoutesI
	Iterator for container for the network routes. More...

Private Member Functions
bool	LookupRoute (const Ipv6RoutingTableEntry &route, uint32_t metric)
	Checks if a route is already present in the forwarding table. More...

Ptr< Ipv6Route >	LookupStatic (Ipv6Address dest, Ptr< NetDevice >=nullptr)
	Lookup in the forwarding table for destination. More...

Ptr< Ipv6MulticastRoute >	LookupStatic (Ipv6Address origin, Ipv6Address group, uint32_t ifIndex)
	Lookup in the multicast forwarding table for destination. More...

Private Attributes
Ptr< Ipv6 >	m_ipv6
	Ipv6 reference. More...

MulticastRoutes	m_multicastRoutes
	the forwarding table for multicast. More...

NetworkRoutes	m_networkRoutes
	the forwarding table for network. More...

Additional Inherited Members
Public Types inherited from ns3::Ipv6RoutingProtocol
typedef Callback< void, Ptr< const Packet >, const Ipv6Header &, Socket::SocketErrno >	ErrorCallback
	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...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

Static routing protocol for IP version 6 stacks.

This class provides a basic set of methods for inserting static unicast and multicast routes into the Ipv6 routing system. This particular protocol is designed to be inserted into an Ipv6ListRouting protocol but can be used also as a standalone protocol.

The Ipv6StaticRouting class inherits from the abstract base class Ipv6RoutingProtocol that defines the interface methods that a routing protocol must support.

See also: Ipv6RoutingProtocol; Ipv6ListRouting; Ipv6ListRouting::AddRoutingProtocol

Definition at line 63 of file ipv6-static-routing.h.

Member Typedef Documentation

◆ MulticastRoutes

typedef std::list<Ipv6MulticastRoutingTableEntry*> ns3::Ipv6StaticRouting::MulticastRoutes

private

Container for the multicast routes.

Definition at line 301 of file ipv6-static-routing.h.

◆ MulticastRoutesCI

typedef std::list<Ipv6MulticastRoutingTableEntry*>::const_iterator ns3::Ipv6StaticRouting::MulticastRoutesCI

private

Const Iterator for container for the multicast routes.

Definition at line 304 of file ipv6-static-routing.h.

◆ MulticastRoutesI

typedef std::list<Ipv6MulticastRoutingTableEntry*>::iterator ns3::Ipv6StaticRouting::MulticastRoutesI

private

Iterator for container for the multicast routes.

Definition at line 307 of file ipv6-static-routing.h.

◆ NetworkRoutes

typedef std::list<std::pair<Ipv6RoutingTableEntry*, uint32_t> > ns3::Ipv6StaticRouting::NetworkRoutes

private

Container for the network routes.

Definition at line 292 of file ipv6-static-routing.h.

◆ NetworkRoutesCI

typedef std::list<std::pair<Ipv6RoutingTableEntry*, uint32_t> >::const_iterator ns3::Ipv6StaticRouting::NetworkRoutesCI

private

Const Iterator for container for the network routes.

Definition at line 295 of file ipv6-static-routing.h.

◆ NetworkRoutesI

typedef std::list<std::pair<Ipv6RoutingTableEntry*, uint32_t> >::iterator ns3::Ipv6StaticRouting::NetworkRoutesI

private

Iterator for container for the network routes.

Definition at line 298 of file ipv6-static-routing.h.

Constructor & Destructor Documentation

◆ Ipv6StaticRouting()

ns3::Ipv6StaticRouting::Ipv6StaticRouting ( )

Definition at line 51 of file ipv6-static-routing.cc.

References NS_LOG_FUNCTION.

◆ ~Ipv6StaticRouting()

ns3::Ipv6StaticRouting::~Ipv6StaticRouting ( )

override

Definition at line 57 of file ipv6-static-routing.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ AddHostRouteTo() [1/2]

void ns3::Ipv6StaticRouting::AddHostRouteTo	(	Ipv6Address	dest,
		Ipv6Address	nextHop,
		uint32_t	interface,
		Ipv6Address	prefixToUse = `Ipv6Address("::")`,
		uint32_t	metric = `0`
	)

Add route to host.

Parameters

dest	destination address
nextHop	next hop address to route the packet.
interface	interface index
prefixToUse	prefix that should be used for source address for this destination
metric	metric of route in case of multiple routes to same destination

Definition at line 148 of file ipv6-static-routing.cc.

References AddNetworkRouteTo(), ns3::Ipv6Prefix::GetOnes(), ns3::Ipv6Address::IsLinkLocal(), NS_LOG_FUNCTION, and NS_LOG_WARN.

Referenced by NotifyInterfaceUp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddHostRouteTo() [2/2]

void ns3::Ipv6StaticRouting::AddHostRouteTo	(	Ipv6Address	dest,
		uint32_t	interface,
		uint32_t	metric = `0`
	)

Add route to host.

Parameters

dest	destination address.
interface	interface index
metric	metric of route in case of multiple routes to same destination

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

References AddNetworkRouteTo(), ns3::Ipv6Prefix::GetOnes(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ AddMulticastRoute()

void ns3::Ipv6StaticRouting::AddMulticastRoute	(	Ipv6Address	origin,
		Ipv6Address	group,
		uint32_t	inputInterface,
		std::vector< uint32_t >	outputInterfaces
	)

Add a multicast route for a given multicast source and group.

Parameters

origin	IPv6 address of the source
group	the multicast group address.
inputInterface	the interface index
outputInterfaces	the list of output interface indices over which the packet should be sent (excluding the inputInterface).

Definition at line 249 of file ipv6-static-routing.cc.

References ns3::Ipv6MulticastRoutingTableEntry::CreateMulticastRoute(), m_multicastRoutes, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ AddNetworkRouteTo() [1/3]

void ns3::Ipv6StaticRouting::AddNetworkRouteTo	(	Ipv6Address	network,
		Ipv6Prefix	networkPrefix,
		Ipv6Address	nextHop,
		uint32_t	interface,
		Ipv6Address	prefixToUse,
		uint32_t	metric = `0`
	)

Add route to network.

Parameters

network	network address
networkPrefix	network prefix*
nextHop	next hop address to route the packet.
interface	interface index
prefixToUse	prefix that should be used for source address for this destination
metric	metric of route in case of multiple routes to same destination

Definition at line 190 of file ipv6-static-routing.cc.

References ns3::Ipv6RoutingTableEntry::CreateNetworkRouteTo(), ns3::Ipv6Address::IsLinkLocal(), LookupRoute(), m_networkRoutes, NS_LOG_FUNCTION, and NS_LOG_WARN.

Here is the call graph for this function:

◆ AddNetworkRouteTo() [2/3]

void ns3::Ipv6StaticRouting::AddNetworkRouteTo	(	Ipv6Address	network,
		Ipv6Prefix	networkPrefix,
		Ipv6Address	nextHop,
		uint32_t	interface,
		uint32_t	metric = `0`
	)

Add route to network.

Parameters

network	network address
networkPrefix	network prefix*
nextHop	next hop address to route the packet
interface	interface index
metric	metric of route in case of multiple routes to same destination

Definition at line 171 of file ipv6-static-routing.cc.

References ns3::Ipv6RoutingTableEntry::CreateNetworkRouteTo(), LookupRoute(), m_networkRoutes, and NS_LOG_FUNCTION.

Referenced by AddHostRouteTo(), NotifyAddRoute(), NotifyInterfaceUp(), and SetDefaultRoute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddNetworkRouteTo() [3/3]

void ns3::Ipv6StaticRouting::AddNetworkRouteTo	(	Ipv6Address	network,
		Ipv6Prefix	networkPrefix,
		uint32_t	interface,
		uint32_t	metric = `0`
	)

Add route to network.

Parameters

network	network address
networkPrefix	network prefix
interface	interface index
metric	metric of route in case of multiple routes to same destination

Definition at line 217 of file ipv6-static-routing.cc.

References ns3::Ipv6RoutingTableEntry::CreateNetworkRouteTo(), LookupRoute(), m_networkRoutes, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ DoDispose()

void ns3::Ipv6StaticRouting::DoDispose ( void )

overrideprotectedvirtual

Dispose this object.

Reimplemented from ns3::Object.

Definition at line 484 of file ipv6-static-routing.cc.

References ns3::Object::DoDispose(), m_ipv6, m_multicastRoutes, m_networkRoutes, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ GetDefaultRoute()

Ipv6RoutingTableEntry ns3::Ipv6StaticRouting::GetDefaultRoute ( )

Get the default route.

If multiple default routes exist, the one with lowest metric is returned.

Returns: default Ipv6Route

Definition at line 564 of file ipv6-static-routing.cc.

References ns3::Ipv6RoutingTableEntry::GetDestNetwork(), ns3::Ipv6RoutingTableEntry::GetDestNetworkPrefix(), ns3::Ipv6Prefix::GetPrefixLength(), m_networkRoutes, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ GetMetric()

uint32_t ns3::Ipv6StaticRouting::GetMetric ( uint32_t index ) const

Get a metric for route from the static unicast routing table.

Parameters

index The index (into the routing table) of the route to retrieve.

Returns: If route is set, the metric is returned. If not, an infinity metric (0xffffffff) is returned

Definition at line 622 of file ipv6-static-routing.cc.

References m_networkRoutes, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by PrintRoutingTable().

Here is the caller graph for this function:

◆ GetMulticastRoute()

Ipv6MulticastRoutingTableEntry ns3::Ipv6StaticRouting::GetMulticastRoute ( uint32_t i ) const

Get the specified multicast route.

Parameters

i index

Returns: the route whose index is i

Definition at line 282 of file ipv6-static-routing.cc.

References m_multicastRoutes, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

◆ GetNMulticastRoutes()

uint32_t ns3::Ipv6StaticRouting::GetNMulticastRoutes ( ) const

Get the number of entries in the multicast routing table.

Returns: number of entries

Definition at line 275 of file ipv6-static-routing.cc.

References m_multicastRoutes, and NS_LOG_FUNCTION.

◆ GetNRoutes()

uint32_t ns3::Ipv6StaticRouting::GetNRoutes ( ) const

Get the number or entries in the routing table.

Returns: number of entries

Definition at line 558 of file ipv6-static-routing.cc.

References m_networkRoutes.

Referenced by PrintRoutingTable().

Here is the caller graph for this function:

◆ GetRoute()

Ipv6RoutingTableEntry ns3::Ipv6StaticRouting::GetRoute ( uint32_t i ) const

Get a specified route.

Parameters

i index

Returns: the route whose index is i

Definition at line 603 of file ipv6-static-routing.cc.

References m_networkRoutes, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by PrintRoutingTable().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::Ipv6StaticRouting::GetTypeId ( void )

static

The interface Id associated with this class.

Returns: type identifier

Definition at line 42 of file ipv6-static-routing.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ HasNetworkDest()

bool ns3::Ipv6StaticRouting::HasNetworkDest	(	Ipv6Address	dest,
		uint32_t	interfaceIndex
	)

If the destination is already present in network destination list.

Parameters

dest	destination address
interfaceIndex	interface index

Returns: true if dest is already in list, false otherwise

Definition at line 342 of file ipv6-static-routing.cc.

References ns3::Ipv6RoutingTableEntry::GetDestNetwork(), ns3::Ipv6RoutingTableEntry::GetDestNetworkPrefix(), ns3::Ipv6RoutingTableEntry::GetInterface(), ns3::Ipv6Prefix::IsMatch(), m_networkRoutes, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ LookupRoute()

bool ns3::Ipv6StaticRouting::LookupRoute	(	const Ipv6RoutingTableEntry &	route,
		uint32_t	metric
	)

private

Checks if a route is already present in the forwarding table.

Parameters

route	route
metric	metric of route

Returns: true if the route/metric is already in the forwarding table

Definition at line 364 of file ipv6-static-routing.cc.

References ns3::Ipv6RoutingTableEntry::GetDest(), ns3::Ipv6RoutingTableEntry::GetDestNetworkPrefix(), ns3::Ipv6RoutingTableEntry::GetGateway(), ns3::Ipv6RoutingTableEntry::GetInterface(), ns3::Ipv6RoutingTableEntry::GetPrefixToUse(), and m_networkRoutes.

Referenced by AddNetworkRouteTo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LookupStatic() [1/2]

Ptr< Ipv6Route > ns3::Ipv6StaticRouting::LookupStatic	(	Ipv6Address	dest,
		Ptr< NetDevice >	interface = `nullptr`
	)

private

Lookup in the forwarding table for destination.

Parameters

dest	destination address
interface	output interface if any (put 0 otherwise)

Returns: Ipv6Route to route the packet to reach dest address

Definition at line 383 of file ipv6-static-routing.cc.

References ns3::Ipv6RoutingTableEntry::GetDest(), ns3::Ipv6RoutingTableEntry::GetDestNetwork(), ns3::Ipv6RoutingTableEntry::GetDestNetworkPrefix(), ns3::Ipv6RoutingTableEntry::GetGateway(), ns3::Ipv6RoutingTableEntry::GetInterface(), ns3::Ipv6Prefix::GetPrefixLength(), ns3::Ipv6RoutingTableEntry::GetPrefixToUse(), ns3::Ipv6Address::GetZero(), ns3::Ipv6Address::IsAny(), ns3::Ipv6Address::IsLinkLocalMulticast(), ns3::Ipv6Prefix::IsMatch(), m_ipv6, m_networkRoutes, NS_ASSERT_MSG, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by RouteInput(), and RouteOutput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LookupStatic() [2/2]

Ptr< Ipv6MulticastRoute > ns3::Ipv6StaticRouting::LookupStatic	(	Ipv6Address	origin,
		Ipv6Address	group,
		uint32_t	ifIndex
	)

private

Lookup in the multicast forwarding table for destination.

Parameters

origin	source address
group	group multicast address
ifIndex	interface index

Returns: Ipv6MulticastRoute to route the packet to reach dest address

Definition at line 506 of file ipv6-static-routing.cc.

References ns3::Ipv6MulticastRoutingTableEntry::GetGroup(), ns3::Ipv6MulticastRoutingTableEntry::GetInputInterface(), ns3::Ipv6MulticastRoutingTableEntry::GetNOutputInterfaces(), ns3::Ipv6MulticastRoutingTableEntry::GetOrigin(), ns3::Ipv6MulticastRoutingTableEntry::GetOutputInterface(), ns3::Ipv6::IF_ANY, m_multicastRoutes, ns3::Ipv6MulticastRoute::MAX_TTL, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Here is the call graph for this function:

◆ NotifyAddAddress()

void ns3::Ipv6StaticRouting::NotifyAddAddress	(	uint32_t	interface,
		Ipv6InterfaceAddress	address
	)

overridevirtual

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

interface	the index of the interface we are being notified about
address	a new address being added to an interface

Implements ns3::Ipv6RoutingProtocol.

Definition at line 826 of file ipv6-static-routing.cc.

References m_ipv6.

◆ NotifyAddRoute()

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

overridevirtual

Notify a new route.

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

Parameters

dst	destination address
mask	destination mask
nextHop	nextHop for this destination
interface	output interface
prefixToUse	prefix to use as source with this route

Implements ns3::Ipv6RoutingProtocol.

Definition at line 864 of file ipv6-static-routing.cc.

References AddNetworkRouteTo(), ns3::Ipv6Address::GetZero(), NS_LOG_FUNCTION, and SetDefaultRoute().

Here is the call graph for this function:

◆ NotifyInterfaceDown()

void ns3::Ipv6StaticRouting::NotifyInterfaceDown ( uint32_t interface )

overridevirtual

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

interface the index of the interface we are being notified about

Implements ns3::Ipv6RoutingProtocol.

Definition at line 806 of file ipv6-static-routing.cc.

References m_networkRoutes, and NS_LOG_FUNCTION.

Referenced by SetIpv6().

Here is the caller graph for this function:

◆ NotifyInterfaceUp()

void ns3::Ipv6StaticRouting::NotifyInterfaceUp ( uint32_t interface )

overridevirtual

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

interface the index of the interface we are being notified about

Implements ns3::Ipv6RoutingProtocol.

Definition at line 779 of file ipv6-static-routing.cc.

References AddHostRouteTo(), AddNetworkRouteTo(), ns3::Ipv6Address::CombinePrefix(), ns3::Ipv6InterfaceAddress::GetAddress(), ns3::Ipv6InterfaceAddress::GetOnLink(), ns3::Ipv6InterfaceAddress::GetPrefix(), and m_ipv6.

Referenced by SetIpv6().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ NotifyRemoveAddress()

void ns3::Ipv6StaticRouting::NotifyRemoveAddress	(	uint32_t	interface,
		Ipv6InterfaceAddress	address
	)

overridevirtual

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

interface	the index of the interface we are being notified about
address	a new address being added to an interface

Implements ns3::Ipv6RoutingProtocol.

Definition at line 835 of file ipv6-static-routing.cc.

References first::address, m_ipv6, and m_networkRoutes.

◆ NotifyRemoveRoute()

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

overridevirtual

Notify route removing.

Parameters

dst	destination address
mask	destination mask
nextHop	nextHop for this destination
interface	output interface
prefixToUse	prefix to use as source with this route

Implements ns3::Ipv6RoutingProtocol.

Definition at line 894 of file ipv6-static-routing.cc.

References ns3::Ipv6RoutingTableEntry::GetDestNetwork(), ns3::Ipv6RoutingTableEntry::GetDestNetworkPrefix(), ns3::Ipv6RoutingTableEntry::GetInterface(), ns3::Ipv6Address::GetZero(), m_networkRoutes, NS_LOG_FUNCTION, and RemoveRoute().

Here is the call graph for this function:

◆ PrintRoutingTable()

void ns3::Ipv6StaticRouting::PrintRoutingTable	(	Ptr< OutputStreamWrapper >	stream,
		Time::Unit	unit = `Time::S`
	)		const

overridevirtual

Print the Routing Table entries.

Parameters

stream	The ostream the Routing table is printed to
unit	The time unit to be used in the report

Implements ns3::Ipv6RoutingProtocol.

Definition at line 85 of file ipv6-static-routing.cc.

References ns3::Time::As(), ns3::Names::FindName(), ns3::Ipv6RoutingTableEntry::GetDest(), ns3::Ipv6RoutingTableEntry::GetDestNetworkPrefix(), ns3::Ipv6RoutingTableEntry::GetGateway(), ns3::Ipv6RoutingTableEntry::GetInterface(), GetMetric(), GetNRoutes(), ns3::Ipv6Prefix::GetPrefixLength(), GetRoute(), ns3::OutputStreamWrapper::GetStream(), ns3::Ipv6RoutingTableEntry::IsGateway(), ns3::Ipv6RoutingTableEntry::IsHost(), m_ipv6, ns3::Now(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ RemoveMulticastRoute() [1/2]

bool ns3::Ipv6StaticRouting::RemoveMulticastRoute	(	Ipv6Address	origin,
		Ipv6Address	group,
		uint32_t	inputInterface
	)

Remove a static multicast route.

Parameters

origin	IPv6 address of the source
group	the multicast group address.
inputInterface	the input interface index

Returns: true on success

Definition at line 304 of file ipv6-static-routing.cc.

References ns3::Ipv6MulticastRoutingTableEntry::GetGroup(), ns3::Ipv6MulticastRoutingTableEntry::GetInputInterface(), ns3::Ipv6MulticastRoutingTableEntry::GetOrigin(), m_multicastRoutes, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ RemoveMulticastRoute() [2/2]

void ns3::Ipv6StaticRouting::RemoveMulticastRoute ( uint32_t i )

Remove a multicast route.

Parameters

i	index of route to remove

Definition at line 324 of file ipv6-static-routing.cc.

References m_multicastRoutes, and NS_LOG_FUNCTION.

◆ RemoveRoute() [1/2]

void ns3::Ipv6StaticRouting::RemoveRoute	(	Ipv6Address	network,
		Ipv6Prefix	prefix,
		uint32_t	ifIndex,
		Ipv6Address	prefixToUse
	)

Remove a route from the routing table.

Parameters

network	IPv6 network
prefix	IPv6 prefix
ifIndex	interface index
prefixToUse	IPv6 prefix to use with this route (multihoming)

Definition at line 660 of file ipv6-static-routing.cc.

References ns3::Ipv6RoutingTableEntry::GetDest(), ns3::Ipv6RoutingTableEntry::GetInterface(), ns3::Ipv6RoutingTableEntry::GetPrefixToUse(), m_networkRoutes, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ RemoveRoute() [2/2]

void ns3::Ipv6StaticRouting::RemoveRoute ( uint32_t i )

Remove a route from the routing table.

Parameters

i index

Definition at line 641 of file ipv6-static-routing.cc.

References m_networkRoutes, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by NotifyRemoveRoute().

Here is the caller graph for this function:

◆ RouteInput()

bool ns3::Ipv6StaticRouting::RouteInput	(	Ptr< const Packet >	p,
		const Ipv6Header &	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 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

p	received packet
header	input parameter used to form a search key for a route
idev	Pointer to ingress network device
ucb	Callback for the case in which the packet is to be forwarded as unicast
mcb	Callback for the case in which the packet is to be forwarded as multicast
lcb	Callback for the case in which the packet is to be locally delivered
ecb	Callback 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 714 of file ipv6-static-routing.cc.

References ns3::Socket::ERROR_NOROUTETOHOST, ns3::Ipv6Header::GetDestination(), ns3::Ipv6Header::GetSource(), ns3::Ipv6Address::IsMulticast(), ns3::Callback< R, UArgs >::IsNull(), LookupStatic(), m_ipv6, NS_ASSERT, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Here is the call graph for this function:

◆ RouteOutput()

Ptr< Ipv6Route > ns3::Ipv6StaticRouting::RouteOutput	(	Ptr< Packet >	p,
		const Ipv6Header &	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 ()

Parameters

p	packet to be routed. Note that this method may modify the packet. Callers may also pass in a null pointer.
header	input parameter (used to form key to search for the route)
oif	Output interface device. May be zero, or may be bound via socket options to a particular output interface.
sockerr	Output parameter; socket errno

Returns: a code that indicates what happened in the lookup

Implements ns3::Ipv6RoutingProtocol.

Definition at line 681 of file ipv6-static-routing.cc.

References ns3::Socket::ERROR_NOROUTETOHOST, ns3::Socket::ERROR_NOTERROR, ns3::Ipv6Header::GetDestination(), ns3::Ipv6Address::IsMulticast(), LookupStatic(), NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Here is the call graph for this function:

◆ SetDefaultMulticastRoute()

void ns3::Ipv6StaticRouting::SetDefaultMulticastRoute ( uint32_t outputInterface )

Set the default multicast route.

Parameters

outputInterface default output interface

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

References ns3::Ipv6RoutingTableEntry::CreateNetworkRouteTo(), m_networkRoutes, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ SetDefaultRoute()

void ns3::Ipv6StaticRouting::SetDefaultRoute	(	Ipv6Address	nextHop,
		uint32_t	interface,
		Ipv6Address	prefixToUse = `Ipv6Address("::")`,
		uint32_t	metric = `0`
	)

Set the default route.

Parameters

nextHop	next hop address to route the packet
interface	interface index
prefixToUse	prefix to use (i.e for multihoming)
metric	metric of route in case of multiple routes to same destination

Definition at line 234 of file ipv6-static-routing.cc.

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

Referenced by NotifyAddRoute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetIpv6()

void ns3::Ipv6StaticRouting::SetIpv6 ( Ptr< Ipv6 > ipv6 )

overridevirtual

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

Parameters

ipv6	the ipv6 object this routing protocol is being associated with

Implements ns3::Ipv6RoutingProtocol.

Definition at line 63 of file ipv6-static-routing.cc.

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

Here is the call graph for this function:

Member Data Documentation

◆ m_ipv6

Ptr<Ipv6> ns3::Ipv6StaticRouting::m_ipv6

private

Ipv6 reference.

Definition at line 347 of file ipv6-static-routing.h.

Referenced by DoDispose(), LookupStatic(), NotifyAddAddress(), NotifyInterfaceUp(), NotifyRemoveAddress(), PrintRoutingTable(), RouteInput(), and SetIpv6().

◆ m_multicastRoutes

MulticastRoutes ns3::Ipv6StaticRouting::m_multicastRoutes

private

the forwarding table for multicast.

Definition at line 342 of file ipv6-static-routing.h.

Referenced by AddMulticastRoute(), DoDispose(), GetMulticastRoute(), GetNMulticastRoutes(), LookupStatic(), and RemoveMulticastRoute().

◆ m_networkRoutes

NetworkRoutes ns3::Ipv6StaticRouting::m_networkRoutes

private

the forwarding table for network.

Definition at line 337 of file ipv6-static-routing.h.

Referenced by AddNetworkRouteTo(), DoDispose(), GetDefaultRoute(), GetMetric(), GetNRoutes(), GetRoute(), HasNetworkDest(), LookupRoute(), LookupStatic(), NotifyInterfaceDown(), NotifyRemoveAddress(), NotifyRemoveRoute(), RemoveRoute(), and SetDefaultMulticastRoute().

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

src/internet/model/ipv6-static-routing.h
src/internet/model/ipv6-static-routing.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ MulticastRoutes

◆ MulticastRoutesCI

◆ MulticastRoutesI

◆ NetworkRoutes

◆ NetworkRoutesCI

◆ NetworkRoutesI

Constructor & Destructor Documentation

◆ Ipv6StaticRouting()

◆ ~Ipv6StaticRouting()

Member Function Documentation

◆ AddHostRouteTo() [1/2]

◆ AddHostRouteTo() [2/2]

◆ AddMulticastRoute()

◆ AddNetworkRouteTo() [1/3]

◆ AddNetworkRouteTo() [2/3]

◆ AddNetworkRouteTo() [3/3]

◆ DoDispose()

◆ GetDefaultRoute()

◆ GetMetric()

◆ GetMulticastRoute()

◆ GetNMulticastRoutes()

◆ GetNRoutes()

◆ GetRoute()

◆ GetTypeId()

◆ HasNetworkDest()

◆ LookupRoute()

◆ LookupStatic() [1/2]

◆ LookupStatic() [2/2]

◆ NotifyAddAddress()

◆ NotifyAddRoute()

◆ NotifyInterfaceDown()

◆ NotifyInterfaceUp()

◆ NotifyRemoveAddress()

◆ NotifyRemoveRoute()

◆ PrintRoutingTable()

◆ RemoveMulticastRoute() [1/2]

◆ RemoveMulticastRoute() [2/2]

◆ RemoveRoute() [1/2]

◆ RemoveRoute() [2/2]

◆ RouteInput()

◆ RouteOutput()

◆ SetDefaultMulticastRoute()

◆ SetDefaultRoute()

◆ SetIpv6()

Member Data Documentation

◆ m_ipv6

◆ m_multicastRoutes

◆ m_networkRoutes