Public Member Functions | Static Public Member Functions | Protected Member Functions

ns3::Ipv6ListRouting Class Reference
[Ipv6 List Routing]

Hold list of Ipv6RoutingProtocol objects. More...

#include <ipv6-list-routing.h>

Inheritance diagram for ns3::Ipv6ListRouting:
Inheritance graph
[legend]
Collaboration diagram for ns3::Ipv6ListRouting:
Collaboration graph
[legend]

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< Ipv6RoutingProtocol > GetRoutingProtocol (uint32_t index, int16_t &priority) const
 Get pointer to routing protocol stored at index,.
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.
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.

Static Public Member Functions

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

Protected Member Functions

void DoDispose (void)
 Dispose this object.

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

virtual 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.
virtual uint32_t ns3::Ipv6ListRouting::GetNRoutingProtocols ( void   )  const [virtual]

Get the number of routing protocols.

Returns:
number of routing protocols in the list
virtual 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
static 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

This object is accessible through the following paths with Config::Set and Config::Connect:

  • /NodeList/[i]/DeviceList/[i]/$ns3::AlohaNoackNetDevice/Phy/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::AlohaNoackNetDevice/Phy/$ns3::Ipv6RoutingProtocol/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::Ipv6RoutingProtocol/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/LinkManager/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/LinkManager/$ns3::Ipv6RoutingProtocol/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/SSManager/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/SSManager/$ns3::Ipv6RoutingProtocol/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::Ipv6RoutingProtocol/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::NonCommunicatingNetDevice/Phy/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::NonCommunicatingNetDevice/Phy/$ns3::Ipv6RoutingProtocol/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/Classifier/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/Classifier/$ns3::Ipv6RoutingProtocol/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::Ipv6RoutingProtocol/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::Ipv6RoutingProtocol/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/NoiseModel/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/NoiseModel/$ns3::Ipv6RoutingProtocol/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/PropagationModel/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/PropagationModel/$ns3::Ipv6RoutingProtocol/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Mac/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Mac/$ns3::Ipv6RoutingProtocol/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Phy/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Phy/$ns3::Ipv6RoutingProtocol/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Transducer/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Transducer/$ns3::Ipv6RoutingProtocol/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::Ipv6RoutingProtocol/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/LinkManager/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/LinkManager/$ns3::Ipv6RoutingProtocol/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/SSManager/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/SSManager/$ns3::Ipv6RoutingProtocol/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::Ipv6RoutingProtocol/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/Classifier/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/Classifier/$ns3::Ipv6RoutingProtocol/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::Ipv6RoutingProtocol/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::Ipv6RoutingProtocol/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BandwidthManager/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BandwidthManager/$ns3::Ipv6RoutingProtocol/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BurstProfileManager/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BurstProfileManager/$ns3::Ipv6RoutingProtocol/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/NoiseModel/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/NoiseModel/$ns3::Ipv6RoutingProtocol/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/PropagationModel/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/PropagationModel/$ns3::Ipv6RoutingProtocol/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/ConnectionManager/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/ConnectionManager/$ns3::Ipv6RoutingProtocol/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/NoiseModel/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/NoiseModel/$ns3::Ipv6RoutingProtocol/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/PropagationModel/$ns3::Ipv6ListRouting
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/PropagationModel/$ns3::Ipv6RoutingProtocol/$ns3::Ipv6ListRouting

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

Reimplemented from ns3::Ipv6RoutingProtocol.

virtual 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.

virtual 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.

virtual 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.

virtual 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.

virtual 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.

virtual 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.

virtual 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.

virtual 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
Returns:
a code that indicates what happened in the lookup

Implements ns3::Ipv6RoutingProtocol.

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

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

Parameters:
ipv6 the ipv6 object this routing protocol is being associated with

Implements ns3::Ipv6RoutingProtocol.

The documentation for this class was generated from the following files:
Generated on Fri Feb 18 2011 15:54:56 for NS-3 by  doxygen 1.7.1