ns-3
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:

List of all members.

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.
virtual uint32_t GetNRoutingProtocols (void) const
 Get the number of routing protocols.
virtual Ptr< Ipv6RoutingProtocolGetRoutingProtocol (uint32_t index, int16_t &priority) const
 Get pointer to routing protocol stored at index,.
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.
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)
virtual void NotifyInterfaceUp (uint32_t interface)
 Notify when specified interface goes UP.
virtual void NotifyInterfaceDown (uint32_t interface)
 Notify when specified interface goes DOWN.
virtual void NotifyAddAddress (uint32_t interface, Ipv6InterfaceAddress address)
 Notify when specified interface add an address.
virtual void NotifyRemoveAddress (uint32_t interface, Ipv6InterfaceAddress address)
 Notify when specified interface add an address.
virtual void NotifyAddRoute (Ipv6Address dst, Ipv6Prefix mask, Ipv6Address nextHop, uint32_t interface, Ipv6Address prefixToUse=Ipv6Address::GetZero())
 Notify a new route.
virtual void NotifyRemoveRoute (Ipv6Address dst, Ipv6Prefix mask, Ipv6Address nextHop, uint32_t interface, Ipv6Address prefixToUse=Ipv6Address::GetZero())
 Notify route removing.
virtual void SetIpv6 (Ptr< Ipv6 > ipv6)
 Typically, invoked directly or indirectly from ns3::Ipv6::SetRoutingProtocol.
virtual void PrintRoutingTable (Ptr< OutputStreamWrapper > stream) const
 Print the Routing Table entries.

Static Public Member Functions

static TypeId GetTypeId (void)
 Get the type ID of this class.

Protected Member Functions

virtual void DoDispose (void)
 Dispose this object.

Additional Inherited Members

- Public Types inherited from ns3::Ipv6RoutingProtocol
typedef Callback< void, Ptr
< Ipv6Route >, Ptr< const
Packet >, const Ipv6Header & > 
UnicastForwardCallback
typedef Callback< void, Ptr
< Ipv6MulticastRoute >, Ptr
< const Packet >, const
Ipv6Header & > 
MulticastForwardCallback
typedef Callback< void, Ptr
< const Packet >, const
Ipv6Header &, uint32_t > 
LocalDeliverCallback
typedef Callback< void, Ptr
< const Packet >, const
Ipv6Header
&, Socket::SocketErrno > 
ErrorCallback

Detailed Description

Hold list of Ipv6RoutingProtocol objects.

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.


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:
routingProtocolnew routing protocol implementation object
prioritypriority to give to this routing protocol. Values may range between -32768 and +32767.

References ns3::Object::GetInstanceTypeId(), NS_LOG_FUNCTION, and ns3::Ipv6RoutingProtocol::SetIpv6().

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

Get the number of routing protocols.

Returns:
number of routing protocols in the list

References NS_LOG_FUNCTION.

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

References NS_FATAL_ERROR, and NS_LOG_FUNCTION.

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

Get the type ID of this class.

This method returns the TypeId associated to ns3::Ipv6ListRouting.

Returns:
type ID

No Attributes defined for this type.
No TraceSources defined for this type.

Reimplemented from ns3::Ipv6RoutingProtocol.

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:
interfacethe index of the interface we are being notified about
addressa new address being added to an interface

Implements ns3::Ipv6RoutingProtocol.

References 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:
dstdestination address
maskdestination mask
nextHopnextHop for this destination
interfaceoutput interface
prefixToUseprefix to use as source with this route

Implements ns3::Ipv6RoutingProtocol.

References 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:
interfacethe index of the interface we are being notified about

Implements ns3::Ipv6RoutingProtocol.

References 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:
interfacethe index of the interface we are being notified about

Implements ns3::Ipv6RoutingProtocol.

References 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:
interfacethe index of the interface we are being notified about
addressa new address being added to an interface

Implements ns3::Ipv6RoutingProtocol.

References 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:
dstdestination address
maskdestination mask
nextHopnextHop for this destination
interfaceoutput interface
prefixToUseprefix to use as source with this route

Implements ns3::Ipv6RoutingProtocol.

References NS_LOG_FUNCTION.

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

Print the Routing Table entries.

Parameters:
streamthe ostream the Routing table is printed to

Implements ns3::Ipv6RoutingProtocol.

References ns3::Object::GetObject(), ns3::Time::GetSeconds(), ns3::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:
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.

References ns3::Packet::Copy(), ns3::Ipv6InterfaceAddress::GetAddress(), ns3::Ipv6::GetAddress(), ns3::Ipv6Address::GetAllHostsMulticast(), ns3::Ipv6Address::GetAllNodesMulticast(), ns3::Ipv6Address::GetAllRoutersMulticast(), ns3::Ipv6Header::GetDestinationAddress(), ns3::Node::GetId(), ns3::Ipv6::GetInterfaceForDevice(), ns3::Ipv6::GetNAddresses(), ns3::Ipv6::GetNInterfaces(), ns3::Object::GetObject(), ns3::Ipv6Address::IsEqual(), ns3::Ipv6::IsForwarding(), ns3::Ipv6Address::IsMulticast(), 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:
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.

References ns3::Ipv6Header::GetDestinationAddress(), ns3::Ipv6Header::GetSourceAddress(), GetTypeId(), NS_LOG_FUNCTION, and NS_LOG_LOGIC.

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.

References NS_ASSERT, and NS_LOG_FUNCTION.


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