ns3::Ipv4StaticRoutingHelper Class Reference

Helper class that adds ns3::Ipv4StaticRouting objects. More...

#include <ipv4-static-routing-helper.h>

Inheritance diagram for ns3::Ipv4StaticRoutingHelper:

[legend]

Collaboration diagram for ns3::Ipv4StaticRoutingHelper:

[legend]

List of all members.

Public Member Functions
	Ipv4StaticRoutingHelper (const Ipv4StaticRoutingHelper &)
	Construct an Ipv4StaticRoutingHelper from another previously initialized instance (Copy Constructor).
Ipv4StaticRoutingHelper *	Copy (void) const
	virtual constructor
virtual Ptr< Ipv4RoutingProtocol >	Create (Ptr< Node > node) const
Ptr< Ipv4StaticRouting >	GetStaticRouting (Ptr< Ipv4 > ipv4) const
void	AddMulticastRoute (Ptr< Node > n, Ipv4Address source, Ipv4Address group, Ptr< NetDevice > input, NetDeviceContainer output)
	Add a multicast route to a node and net device using explicit Ptr<Node> and Ptr<NetDevice>.
void	AddMulticastRoute (std::string n, Ipv4Address source, Ipv4Address group, Ptr< NetDevice > input, NetDeviceContainer output)
	Add a multicast route to a node and device using a name string previously associated to the node using the Object Name Service and a Ptr<NetDevice>.
void	AddMulticastRoute (Ptr< Node > n, Ipv4Address source, Ipv4Address group, std::string inputName, NetDeviceContainer output)
	Add a multicast route to a node and device using a Ptr<Node> and a name string previously associated to the device using the Object Name Service.
void	AddMulticastRoute (std::string nName, Ipv4Address source, Ipv4Address group, std::string inputName, NetDeviceContainer output)
	Add a multicast route to a node and device using name strings previously associated to both the node and device using the Object Name Service.
void	SetDefaultMulticastRoute (Ptr< Node > n, Ptr< NetDevice > nd)
	Add a default route to the static routing protocol to forward packets out a particular interface.
void	SetDefaultMulticastRoute (Ptr< Node > n, std::string ndName)
	Add a default route to the static routing protocol to forward packets out a particular interface.
void	SetDefaultMulticastRoute (std::string nName, Ptr< NetDevice > nd)
	Add a default route to the static routing protocol to forward packets out a particular interface.
void	SetDefaultMulticastRoute (std::string nName, std::string ndName)
	Add a default route to the static routing protocol to forward packets out a particular interface.

---

Detailed Description

Helper class that adds ns3::Ipv4StaticRouting objects.

This class is expected to be used in conjunction with ns3::InternetStackHelper::SetRoutingHelper

---

Member Function Documentation

Ipv4StaticRoutingHelper* ns3::Ipv4StaticRoutingHelper::Copy

(

void

)

const [virtual]

virtual constructor

Returns:

pointer to clone of this Ipv4RoutingHelper

This method is mainly for internal use by the other helpers; clients are expected to free the dynamic memory allocated by this method

Implements ns3::Ipv4RoutingHelper.

virtual Ptr<Ipv4RoutingProtocol> ns3::Ipv4StaticRoutingHelper::Create

(

Ptr< Node >

node

)

const [virtual]

Parameters:

node

the node on which the routing protocol will run

Returns:

a newly-created routing protocol

This method will be called by ns3::InternetStackHelper::Install

Implements ns3::Ipv4RoutingHelper.

Ptr<Ipv4StaticRouting> ns3::Ipv4StaticRoutingHelper::GetStaticRouting

(

Ptr< Ipv4 >

ipv4

)

const

Try and find the static routing protocol as either the main routing protocol or in the list of routing protocols associated with the Ipv4 provided.

Parameters:

ipv4

the Ptr<Ipv4> to search for the static routing protocol

void ns3::Ipv4StaticRoutingHelper::SetDefaultMulticastRoute	(	std::string	nName,
		std::string	ndName
	)

Add a default route to the static routing protocol to forward packets out a particular interface.

Functionally equivalent to: route add 224.0.0.0 netmask 240.0.0.0 dev nd

Parameters:

	nName	string with name previously associated to node using the Object Name Service
	ndName	string with name previously associated to device using the Object Name Service

void ns3::Ipv4StaticRoutingHelper::SetDefaultMulticastRoute	(	std::string	nName,
		Ptr< NetDevice >	nd
	)

Add a default route to the static routing protocol to forward packets out a particular interface.

Functionally equivalent to: route add 224.0.0.0 netmask 240.0.0.0 dev nd

Parameters:

	nName	string with name previously associated to node using the Object Name Service
	nd	device of the node to add default route

void ns3::Ipv4StaticRoutingHelper::SetDefaultMulticastRoute	(	Ptr< Node >	n,
		std::string	ndName
	)

Add a default route to the static routing protocol to forward packets out a particular interface.

Functionally equivalent to: route add 224.0.0.0 netmask 240.0.0.0 dev nd

Parameters:

	n	node
	ndName	string with name previously associated to device using the Object Name Service

void ns3::Ipv4StaticRoutingHelper::SetDefaultMulticastRoute	(	Ptr< Node >	n,
		Ptr< NetDevice >	nd
	)

Add a default route to the static routing protocol to forward packets out a particular interface.

Functionally equivalent to: route add 224.0.0.0 netmask 240.0.0.0 dev nd

Parameters:

	n	node
	nd	device of the node to add default route

---

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

• src/routing/static-routing/helper/ipv4-static-routing-helper.h