ns3::Ipv4GlobalRouting Class Reference

Global routing protocol for IP version 4 stacks. More...

#include <ipv4-global-routing.h>

Inheritance diagram for ns3::Ipv4GlobalRouting:

Collaboration diagram for ns3::Ipv4GlobalRouting:

List of all members.

Public Member Functions
	Ipv4GlobalRouting ()
	Construct an empty Ipv4GlobalRouting routing protocol,.
virtual Ptr< Ipv4Route >	RouteOutput (Ptr< Packet > p, const Ipv4Header &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 Ipv4Header &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)
virtual void	NotifyInterfaceDown (uint32_t interface)
virtual void	NotifyAddAddress (uint32_t interface, Ipv4InterfaceAddress address)
virtual void	NotifyRemoveAddress (uint32_t interface, Ipv4InterfaceAddress address)
virtual void	SetIpv4 (Ptr< Ipv4 > ipv4)
void	AddHostRouteTo (Ipv4Address dest, Ipv4Address nextHop, uint32_t interface)
	Add a host route to the global routing table.
void	AddHostRouteTo (Ipv4Address dest, uint32_t interface)
	Add a host route to the global routing table.
void	AddNetworkRouteTo (Ipv4Address network, Ipv4Mask networkMask, Ipv4Address nextHop, uint32_t interface)
	Add a network route to the global routing table.
void	AddNetworkRouteTo (Ipv4Address network, Ipv4Mask networkMask, uint32_t interface)
	Add a network route to the global routing table.
void	AddASExternalRouteTo (Ipv4Address network, Ipv4Mask networkMask, Ipv4Address nextHop, uint32_t interface)
	Add an external route to the global routing table.
uint32_t	GetNRoutes (void)
	Get the number of individual unicast routes that have been added to the routing table.
Ipv4RoutingTableEntry *	GetRoute (uint32_t i)
	Get a route from the global unicast routing table.
void	RemoveRoute (uint32_t i)
	Remove a route from the global unicast routing table.
Static Public Member Functions
static TypeId	GetTypeId (void)
	This method returns the TypeId associated to ns3::Ipv4GlobalRouting.
Protected Member Functions
void	DoDispose (void)

---

Detailed Description

Global routing protocol for IP version 4 stacks.

In ns-3 we have the concept of a pluggable routing protocol. Routing protocols are added to a list maintained by the Ipv4L3Protocol. Every stack gets one routing protocol for free -- the Ipv4StaticRouting routing protocol is added in the constructor of the Ipv4L3Protocol (this is the piece of code that implements the functionality of the IP layer).

As an option to running a dynamic routing protocol, a GlobalRouteManager object has been created to allow users to build routes for all participating nodes. One can think of this object as a "routing oracle"; it has an omniscient view of the topology, and can construct shortest path routes between all pairs of nodes. These routes must be stored somewhere in the node, so therefore this class Ipv4GlobalRouting is used as one of the pluggable routing protocols. It is kept distinct from Ipv4StaticRouting because these routes may be dynamically cleared and rebuilt in the middle of the simulation, while manually entered routes into the Ipv4StaticRouting may need to be kept distinct.

This class deals with Ipv4 unicast routes only.

See also:

Ipv4RoutingProtocol

GlobalRouteManager

---

Constructor & Destructor Documentation

ns3::Ipv4GlobalRouting::Ipv4GlobalRouting

(

)

Construct an empty Ipv4GlobalRouting routing protocol,.

The Ipv4GlobalRouting class supports host and network unicast routes. This method initializes the lists containing these routes to empty.

See also:

Ipv4GlobalRouting

---

Member Function Documentation

void ns3::Ipv4GlobalRouting::AddASExternalRouteTo	(	Ipv4Address	network,
		Ipv4Mask	networkMask,
		Ipv4Address	nextHop,
		uint32_t	interface
	)

Add an external route to the global routing table.

Parameters:

	network	The Ipv4Address network for this route.
	networkMask	The Ipv4Mask to extract the network.
	nextHop	The next hop Ipv4Address
	interface	The network interface index used to send packets to the destination.

void ns3::Ipv4GlobalRouting::AddHostRouteTo	(	Ipv4Address	dest,
		uint32_t	interface
	)

Add a host route to the global routing table.

Parameters:

	dest	The Ipv4Address destination for this route.
	interface	The network interface index used to send packets to the destination.

See also:

Ipv4Address

void ns3::Ipv4GlobalRouting::AddHostRouteTo	(	Ipv4Address	dest,
		Ipv4Address	nextHop,
		uint32_t	interface
	)

Add a host route to the global routing table.

Parameters:

	dest	The Ipv4Address destination for this route.
	nextHop	The Ipv4Address of the next hop in the route.
	interface	The network interface index used to send packets to the destination.

See also:

Ipv4Address

void ns3::Ipv4GlobalRouting::AddNetworkRouteTo	(	Ipv4Address	network,
		Ipv4Mask	networkMask,
		Ipv4Address	nextHop,
		uint32_t	interface
	)

Add a network route to the global routing table.

Parameters:

	network	The Ipv4Address network for this route.
	networkMask	The Ipv4Mask to extract the network.
	nextHop	The next hop in the route to the destination network.
	interface	The network interface index used to send packets to the destination.

See also:

Ipv4Address

void ns3::Ipv4GlobalRouting::AddNetworkRouteTo	(	Ipv4Address	network,
		Ipv4Mask	networkMask,
		uint32_t	interface
	)

Add a network route to the global routing table.

Parameters:

	network	The Ipv4Address network for this route.
	networkMask	The Ipv4Mask to extract the network.
	interface	The network interface index used to send packets to the destination.

See also:

Ipv4Address

void ns3::Ipv4GlobalRouting::DoDispose

(

void

)

[protected, virtual]

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden version of this method and chain up to their parent's implementation once they are done. i.e., for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose method.

It is safe to call GetObject from within this method.

Reimplemented from ns3::Object.

uint32_t ns3::Ipv4GlobalRouting::GetNRoutes

(

void

)

Get the number of individual unicast routes that have been added to the routing table.

Warning:

The default route counts as one of the routes.

Ipv4RoutingTableEntry* ns3::Ipv4GlobalRouting::GetRoute

(

uint32_t

i

)

Get a route from the global unicast routing table.

Externally, the unicast global routing table appears simply as a table with n entries. The one subtlety of note is that if a default route has been set it will appear as the zeroth entry in the table. This means that if you add only a default route, the table will have one entry that can be accessed either by explicitly calling GetDefaultRoute () or by calling GetRoute (0).

Similarly, if the default route has been set, calling RemoveRoute (0) will remove the default route.

Parameters:

i

The index (into the routing table) of the route to retrieve. If the default route has been set, it will occupy index zero.

Returns:

If route is set, a pointer to that Ipv4RoutingTableEntry is returned, otherwise a zero pointer is returned.

See also:

Ipv4RoutingTableEntry

Ipv4GlobalRouting::RemoveRoute

static TypeId ns3::Ipv4GlobalRouting::GetTypeId

(

void

)

[static]

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

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

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

Attributes defined for this type:

• RandomEcmpRouting: Set to true if packets are randomly routed among ECMP; set to false for using only one route consistently
  • Set with class: BooleanValue
  • Underlying type: bool
  • Initial value: false
  • Flags: construct write read
• RespondToInterfaceEvents: Set to true if you want to dynamically recompute the global routes upon Interface notification events (up/down, or add/remove address)
  • Set with class: BooleanValue
  • Underlying type: bool
  • Initial value: false
  • Flags: construct write read

No TraceSources defined for this type.

Reimplemented from ns3::Ipv4RoutingProtocol.

virtual void ns3::Ipv4GlobalRouting::NotifyAddAddress	(	uint32_t	interface,
		Ipv4InterfaceAddress	address
	)			[virtual]

Parameters:

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

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.

Implements ns3::Ipv4RoutingProtocol.

virtual void ns3::Ipv4GlobalRouting::NotifyInterfaceDown

(

uint32_t

interface

)

[virtual]

Parameters:

interface

the index of the interface we are being notified about

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

Implements ns3::Ipv4RoutingProtocol.

virtual void ns3::Ipv4GlobalRouting::NotifyInterfaceUp

(

uint32_t

interface

)

[virtual]

Parameters:

interface

the index of the interface we are being notified about

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

Implements ns3::Ipv4RoutingProtocol.

virtual void ns3::Ipv4GlobalRouting::NotifyRemoveAddress	(	uint32_t	interface,
		Ipv4InterfaceAddress	address
	)			[virtual]

Parameters:

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

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.

Implements ns3::Ipv4RoutingProtocol.

void ns3::Ipv4GlobalRouting::RemoveRoute

(

uint32_t

i

)

Remove a route from the global unicast routing table.

Externally, the unicast global routing table appears simply as a table with n entries. The one subtlety of note is that if a default route has been set it will appear as the zeroth entry in the table. This means that if the default route has been set, calling RemoveRoute (0) will remove the default route.

Parameters:

i

The index (into the routing table) of the route to remove. If the default route has been set, it will occupy index zero.

See also:

Ipv4RoutingTableEntry

Ipv4GlobalRouting::GetRoute

Ipv4GlobalRouting::AddRoute

virtual bool ns3::Ipv4GlobalRouting::RouteInput	(	Ptr< const Packet >	p,
		const Ipv4Header &	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 Ipv4RoutingProtocol, 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 Ipv4RoutingProtocol takes responsibility for forwarding or delivering the packet, false otherwise

Implements ns3::Ipv4RoutingProtocol.

virtual Ptr<Ipv4Route> ns3::Ipv4GlobalRouting::RouteOutput	(	Ptr< Packet >	p,
		const Ipv4Header &	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 Netdevice. 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::Ipv4RoutingProtocol.

virtual void ns3::Ipv4GlobalRouting::SetIpv4

(

Ptr< Ipv4 >

ipv4

)

[virtual]

Parameters:

ipv4

the ipv4 object this routing protocol is being associated with

Typically, invoked directly or indirectly from ns3::Ipv4::SetRoutingProtocol

Implements ns3::Ipv4RoutingProtocol.

---

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

• src/routing/global-routing/ipv4-global-routing.h
• doc/introspected-doxygen.h