Hold list of Ipv6RoutingProtocol objects. More...

#include <introspected-doxygen.h>

Inheritance diagram for ns3::Ipv6ListRouting:

Public Member Functions
	Ipv6ListRouting ()
	Constructor.

virtual	~Ipv6ListRouting ()
	Destructor.

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< Ipv6RoutingProtocol >	GetRoutingProtocol (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) 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< Ipv6Route >	RouteOutput (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
void	AggregateObject (Ptr< Object > other)

void	Dispose (void)

AggregateIterator	GetAggregateIterator (void) const

virtual TypeId	GetInstanceTypeId (void) const

template<typename T >
Ptr< T >	GetObject (void) const

template<typename T >
Ptr< T >	GetObject (TypeId tid) const

void	Initialize (void)

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount (const SimpleRefCount &o)

uint32_t	GetReferenceCount (void) const

SimpleRefCount &	operator= (const SimpleRefCount &o)

void	Ref (void) const

void	Unref (void) const

Public Member Functions inherited from ns3::ObjectBase
void	GetAttribute (std::string name, AttributeValue &value) const

bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const

void	SetAttribute (std::string name, const AttributeValue &value)

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

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)

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)

Protected Member Functions
virtual void	DoDispose (void)
	Dispose this object.

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)

virtual void	DoInitialize (void)

virtual void	NotifyNewAggregate (void)

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)

Private Types
typedef std::pair< int16_t, Ptr< Ipv6RoutingProtocol > >	Ipv6RoutingProtocolEntry

typedef std::list < Ipv6RoutingProtocolEntry >	Ipv6RoutingProtocolList

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

Private Attributes
Ptr< Ipv6 >	m_ipv6
	Ipv6 reference.

Ipv6RoutingProtocolList	m_routingProtocols
	List of routing protocols.

Additional Inherited Members
Public Types inherited from ns3::Ipv6RoutingProtocol
typedef Callback< void, Ptr < const Packet >, const Ipv6Header &, Socket::SocketErrno >	ErrorCallback

typedef Callback< void, Ptr < const Packet >, const Ipv6Header &, uint32_t >	LocalDeliverCallback

typedef Callback< void, Ptr < Ipv6MulticastRoute >, Ptr < const Packet >, const Ipv6Header & >	MulticastForwardCallback

typedef Callback< void, Ptr < Ipv6Route >, Ptr< const Packet >, const Ipv6Header & >	UnicastForwardCallback

Detailed Description

Hold list of Ipv6RoutingProtocol objects.

Doxygen introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.

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.

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

Member Function Documentation

void ns3::Ipv6ListRouting::AddRoutingProtocol	(	Ptr< Ipv6RoutingProtocol >	routingProtocol,
		int16_t	priority
	)

virtual

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

Parameters

routingProtocol	new routing protocol implementation object
priority	priority to give to this routing protocol. Values may range between -32768 and +32767.

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

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

Referenced by Ipv6ListRoutingNegativeTestCase::DoRun(), and Ipv6ListRoutingPositiveTestCase::DoRun().

bool ns3::Ipv6ListRouting::Compare	(	const Ipv6RoutingProtocolEntry &	a,
		const Ipv6RoutingProtocolEntry &	b
	)

staticprivate

Compare two routing protocols.

Parameters

a	first object to compare
b	second object to compare

Returns: true if they are the same, false otherwise

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

Referenced by AddRoutingProtocol().

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 318 of file ipv6-list-routing.cc.

References m_routingProtocols, and NS_LOG_FUNCTION.

Referenced by Ipv6ListRoutingNegativeTestCase::DoRun(), and Ipv6ListRoutingPositiveTestCase::DoRun().

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

index	index of protocol to return
priority	output parameter, set to the priority of the protocol being returned

Returns: pointer to routing protocol indexed by

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

References m_routingProtocols, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

Referenced by Ipv6ListRoutingNegativeTestCase::DoRun(), and Ipv6ListRoutingPositiveTestCase::DoRun().

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

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

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 225 of file ipv6-list-routing.cc.

References m_routingProtocols, and NS_LOG_FUNCTION.

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

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 249 of file ipv6-list-routing.cc.

References m_routingProtocols, and NS_LOG_FUNCTION.

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

interface the index of the interface we are being notified about

Implements ns3::Ipv6RoutingProtocol.

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

References m_routingProtocols, and NS_LOG_FUNCTION.

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

interface the index of the interface we are being notified about

Implements ns3::Ipv6RoutingProtocol.

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

References m_routingProtocols, and NS_LOG_FUNCTION.

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

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 237 of file ipv6-list-routing.cc.

References m_routingProtocols, and NS_LOG_FUNCTION.

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

virtual

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 261 of file ipv6-list-routing.cc.

References m_routingProtocols, and NS_LOG_FUNCTION.

void ns3::Ipv6ListRouting::PrintRoutingTable ( Ptr< OutputStreamWrapper > stream ) const

virtual

Print the Routing Table entries.

Parameters

stream the ostream the Routing table is printed to

Implements ns3::Ipv6RoutingProtocol.

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

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

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

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 99 of file ipv6-list-routing.cc.

References ns3::Packet::Copy(), ns3::Ipv6InterfaceAddress::GetAddress(), ns3::Ipv6Address::GetAllHostsMulticast(), ns3::Ipv6Address::GetAllNodesMulticast(), ns3::Ipv6Address::GetAllRoutersMulticast(), ns3::Ipv6Header::GetDestinationAddress(), ns3::Node::GetId(), ns3::Ipv6Address::IsEqual(), ns3::Ipv6Address::IsMulticast(), m_ipv6, m_routingProtocols, NS_ASSERT, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

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

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