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

#include "ipv4-static-routing.h"

Inheritance diagram for ns3::Ipv4StaticRouting:

Collaboration diagram for ns3::Ipv4StaticRouting:

Public Member Functions
	Ipv4StaticRouting ()

	~Ipv4StaticRouting () override

void	AddHostRouteTo (Ipv4Address dest, Ipv4Address nextHop, uint32_t interface, uint32_t metric=0)
	Add a host route to the static routing table. More...

void	AddHostRouteTo (Ipv4Address dest, uint32_t interface, uint32_t metric=0)
	Add a host route to the static routing table. More...

void	AddMulticastRoute (Ipv4Address origin, Ipv4Address group, uint32_t inputInterface, std::vector< uint32_t > outputInterfaces)
	Add a multicast route to the static routing table. More...

void	AddNetworkRouteTo (Ipv4Address network, Ipv4Mask networkMask, Ipv4Address nextHop, uint32_t interface, uint32_t metric=0)
	Add a network route to the static routing table. More...

void	AddNetworkRouteTo (Ipv4Address network, Ipv4Mask networkMask, uint32_t interface, uint32_t metric=0)
	Add a network route to the static routing table. More...

Ipv4RoutingTableEntry	GetDefaultRoute ()
	Get the default route with lowest metric from the static routing table. More...

uint32_t	GetMetric (uint32_t index) const
	Get a metric for route from the static unicast routing table. More...

Ipv4MulticastRoutingTableEntry	GetMulticastRoute (uint32_t i) const
	Get a route from the static multicast routing table. More...

uint32_t	GetNMulticastRoutes () const
	Get the number of individual multicast routes that have been added to the routing table. More...

uint32_t	GetNRoutes () const
	Get the number of individual unicast routes that have been added to the routing table. More...

Ipv4RoutingTableEntry	GetRoute (uint32_t i) const
	Get a route from the static unicast routing table. More...

void	NotifyAddAddress (uint32_t interface, Ipv4InterfaceAddress address) override

void	NotifyInterfaceDown (uint32_t interface) override

void	NotifyInterfaceUp (uint32_t interface) override

void	NotifyRemoveAddress (uint32_t interface, Ipv4InterfaceAddress address) override

void	PrintRoutingTable (Ptr< OutputStreamWrapper > stream, Time::Unit unit=Time::S) const override
	Print the Routing Table entries. More...

bool	RemoveMulticastRoute (Ipv4Address origin, Ipv4Address group, uint32_t inputInterface)
	Remove a route from the static multicast routing table. More...

void	RemoveMulticastRoute (uint32_t index)
	Remove a route from the static multicast routing table. More...

void	RemoveRoute (uint32_t i)
	Remove a route from the static unicast routing table. More...

bool	RouteInput (Ptr< const Packet > p, const Ipv4Header &header, Ptr< const NetDevice > idev, const UnicastForwardCallback &ucb, const MulticastForwardCallback &mcb, const LocalDeliverCallback &lcb, const ErrorCallback &ecb) override
	Route an input packet (to be forwarded or locally delivered) More...

Ptr< Ipv4Route >	RouteOutput (Ptr< Packet > p, const Ipv4Header &header, Ptr< NetDevice > oif, Socket::SocketErrno &sockerr) override
	Query routing cache for an existing route, for an outbound packet. More...

void	SetDefaultMulticastRoute (uint32_t outputInterface)
	Add a default multicast route to the static routing table. More...

void	SetDefaultRoute (Ipv4Address nextHop, uint32_t interface, uint32_t metric=0)
	Add a default route to the static routing table. More...

void	SetIpv4 (Ptr< Ipv4 > ipv4) override

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor. More...

	~Object () override
	Destructor. More...

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together. More...

void	Dispose ()
	Dispose of this Object. More...

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one. More...

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object. More...

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object. More...

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object. More...

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId. More...

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object. More...

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one. More...

bool	IsInitialized () const
	Check if the object has been initialized. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor. More...

	SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
	Copy constructor. More...

uint32_t	GetReferenceCount () const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o[[maybe_unused]])
	Assignment operator. More...

void	Ref () const
	Increment the reference count. More...

void	Unref () const
	Decrement the reference count. More...

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful. More...

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors. More...

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful. More...

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors. More...

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context. More...

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context. More...

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context. More...

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context. More...

Static Public Member Functions
static TypeId	GetTypeId ()
	The interface Id associated with this class. More...

Static Public Member Functions inherited from ns3::Ipv4RoutingProtocol
static TypeId	GetTypeId ()
	Get the type ID. More...

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type. More...

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID. More...

Protected Member Functions
void	DoDispose () override
	Destructor implementation. More...

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object. More...

virtual void	DoInitialize ()
	Initialize() implementation. More...

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes. More...

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed. More...

Private Types
typedef std::list< Ipv4MulticastRoutingTableEntry * >	MulticastRoutes
	Container for the multicast routes. More...

typedef std::list< Ipv4MulticastRoutingTableEntry * >::const_iterator	MulticastRoutesCI
	Const Iterator for container for the multicast routes. More...

typedef std::list< Ipv4MulticastRoutingTableEntry * >::iterator	MulticastRoutesI
	Iterator for container for the multicast routes. More...

typedef std::list< std::pair< Ipv4RoutingTableEntry *, uint32_t > >	NetworkRoutes
	Container for the network routes. More...

typedef std::list< std::pair< Ipv4RoutingTableEntry *, uint32_t > >::const_iterator	NetworkRoutesCI
	Const Iterator for container for the network routes. More...

typedef std::list< std::pair< Ipv4RoutingTableEntry *, uint32_t > >::iterator	NetworkRoutesI
	Iterator for container for the network routes. More...

Private Member Functions
bool	LookupRoute (const Ipv4RoutingTableEntry &route, uint32_t metric)
	Checks if a route is already present in the forwarding table. More...

Ptr< Ipv4Route >	LookupStatic (Ipv4Address dest, Ptr< NetDevice > oif=nullptr)
	Lookup in the forwarding table for destination. More...

Ptr< Ipv4MulticastRoute >	LookupStatic (Ipv4Address origin, Ipv4Address group, uint32_t interface)
	Lookup in the multicast forwarding table for destination. More...

Private Attributes
Ptr< Ipv4 >	m_ipv4
	Ipv4 reference. More...

MulticastRoutes	m_multicastRoutes
	the forwarding table for multicast. More...

NetworkRoutes	m_networkRoutes
	the forwarding table for network. More...

Additional Inherited Members
Public Types inherited from ns3::Ipv4RoutingProtocol
typedef Callback< void, Ptr< const Packet >, const Ipv4Header &, Socket::SocketErrno >	ErrorCallback
	Callback for routing errors (e.g., no route found) More...

typedef Callback< void, Ptr< const Packet >, const Ipv4Header &, uint32_t >	LocalDeliverCallback
	Callback for packets to be locally delivered. More...

typedef Callback< void, Ptr< Ipv4MulticastRoute >, Ptr< const Packet >, const Ipv4Header & >	MulticastForwardCallback
	Callback for multicast packets to be forwarded. More...

typedef Callback< void, Ptr< Ipv4Route >, Ptr< const Packet >, const Ipv4Header & >	UnicastForwardCallback
	Callback for unicast packets to be forwarded. More...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

Static routing protocol for IP version 4 stacks.

This class provides a basic set of methods for inserting static unicast and multicast routes into the Ipv4 routing system. This particular protocol is designed to be inserted into an Ipv4ListRouting protocol but can be used also as a standalone protocol.

The Ipv4StaticRouting class inherits from the abstract base class Ipv4RoutingProtocol that defines the interface methods that a routing protocol must support.

See also: Ipv4RoutingProtocol; Ipv4ListRouting; Ipv4ListRouting::AddRoutingProtocol

Definition at line 67 of file ipv4-static-routing.h.

Member Typedef Documentation

◆ MulticastRoutes

typedef std::list<Ipv4MulticastRoutingTableEntry*> ns3::Ipv4StaticRouting::MulticastRoutes

private

Container for the multicast routes.

Definition at line 376 of file ipv4-static-routing.h.

◆ MulticastRoutesCI

typedef std::list<Ipv4MulticastRoutingTableEntry*>::const_iterator ns3::Ipv4StaticRouting::MulticastRoutesCI

private

Const Iterator for container for the multicast routes.

Definition at line 379 of file ipv4-static-routing.h.

◆ MulticastRoutesI

typedef std::list<Ipv4MulticastRoutingTableEntry*>::iterator ns3::Ipv4StaticRouting::MulticastRoutesI

private

Iterator for container for the multicast routes.

Definition at line 382 of file ipv4-static-routing.h.

◆ NetworkRoutes

typedef std::list<std::pair<Ipv4RoutingTableEntry*, uint32_t> > ns3::Ipv4StaticRouting::NetworkRoutes

private

Container for the network routes.

Definition at line 367 of file ipv4-static-routing.h.

◆ NetworkRoutesCI

typedef std::list<std::pair<Ipv4RoutingTableEntry*, uint32_t> >::const_iterator ns3::Ipv4StaticRouting::NetworkRoutesCI

private

Const Iterator for container for the network routes.

Definition at line 370 of file ipv4-static-routing.h.

◆ NetworkRoutesI

typedef std::list<std::pair<Ipv4RoutingTableEntry*, uint32_t> >::iterator ns3::Ipv4StaticRouting::NetworkRoutesI

private

Iterator for container for the network routes.

Definition at line 373 of file ipv4-static-routing.h.

Constructor & Destructor Documentation

◆ Ipv4StaticRouting()

ns3::Ipv4StaticRouting::Ipv4StaticRouting ( )

Definition at line 60 of file ipv4-static-routing.cc.

References NS_LOG_FUNCTION.

◆ ~Ipv4StaticRouting()

ns3::Ipv4StaticRouting::~Ipv4StaticRouting ( )

override

Definition at line 582 of file ipv4-static-routing.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ AddHostRouteTo() [1/2]

void ns3::Ipv4StaticRouting::AddHostRouteTo	(	Ipv4Address	dest,
		Ipv4Address	nextHop,
		uint32_t	interface,
		uint32_t	metric = `0`
	)

Add a host route to the static 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.
metric	Metric of route in case of multiple routes to same destination

See also: Ipv4Address

Definition at line 105 of file ipv4-static-routing.cc.

References AddNetworkRouteTo(), ns3::Ipv4Mask::GetOnes(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ AddHostRouteTo() [2/2]

void ns3::Ipv4StaticRouting::AddHostRouteTo	(	Ipv4Address	dest,
		uint32_t	interface,
		uint32_t	metric = `0`
	)

Add a host route to the static routing table.

Parameters

dest	The Ipv4Address destination for this route.
interface	The network interface index used to send packets to the destination.
metric	Metric of route in case of multiple routes to same destination

See also: Ipv4Address

Definition at line 115 of file ipv4-static-routing.cc.

References AddNetworkRouteTo(), ns3::Ipv4Mask::GetOnes(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ AddMulticastRoute()

void ns3::Ipv4StaticRouting::AddMulticastRoute	(	Ipv4Address	origin,
		Ipv4Address	group,
		uint32_t	inputInterface,
		std::vector< uint32_t >	outputInterfaces
	)

Add a multicast route to the static routing table.

A multicast route must specify an origin IP address, a multicast group and an input network interface index as conditions and provide a vector of output network interface indices over which packets matching the conditions are sent.

Typically there are two main types of multicast routes: routes used during forwarding, and routes used in the originator node. For forwarding, all of the conditions must be explicitly provided. For originator nodes, the route is equivalent to a unicast route, and must be added through AddHostRouteTo.

Parameters

origin	The Ipv4Address of the origin of packets for this route. May be Ipv4Address:GetAny for open groups.
group	The Ipv4Address of the multicast group or this route.
inputInterface	The input network interface index over which to expect packets destined for this route.
outputInterfaces	A vector of network interface indexes used to specify how to send packets to the destination(s).

See also: Ipv4Address

Definition at line 129 of file ipv4-static-routing.cc.

References ns3::Ipv4MulticastRoutingTableEntry::CreateMulticastRoute(), m_multicastRoutes, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ AddNetworkRouteTo() [1/2]

void ns3::Ipv4StaticRouting::AddNetworkRouteTo	(	Ipv4Address	network,
		Ipv4Mask	networkMask,
		Ipv4Address	nextHop,
		uint32_t	interface,
		uint32_t	metric = `0`
	)

Add a network route to the static 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.
metric	Metric of route in case of multiple routes to same destination

See also: Ipv4Address

Definition at line 67 of file ipv4-static-routing.cc.

References ns3::Ipv4RoutingTableEntry::CreateNetworkRouteTo(), LookupRoute(), m_networkRoutes, and NS_LOG_FUNCTION.

Referenced by AddHostRouteTo(), NotifyAddAddress(), NotifyInterfaceUp(), and SetDefaultRoute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddNetworkRouteTo() [2/2]

void ns3::Ipv4StaticRouting::AddNetworkRouteTo	(	Ipv4Address	network,
		Ipv4Mask	networkMask,
		uint32_t	interface,
		uint32_t	metric = `0`
	)

Add a network route to the static 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.
metric	Metric of route in case of multiple routes to same destination

See also: Ipv4Address

Definition at line 87 of file ipv4-static-routing.cc.

References ns3::Ipv4RoutingTableEntry::CreateNetworkRouteTo(), LookupRoute(), m_networkRoutes, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ DoDispose()

void ns3::Ipv4StaticRouting::DoDispose ( void )

overrideprotectedvirtual

Destructor implementation.

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

Subclasses are expected to implement their real destruction code in an overridden 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.

Definition at line 588 of file ipv4-static-routing.cc.

References ns3::Object::DoDispose(), m_ipv4, m_multicastRoutes, m_networkRoutes, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ GetDefaultRoute()

Ipv4RoutingTableEntry ns3::Ipv4StaticRouting::GetDefaultRoute ( )

Get the default route with lowest metric from the static routing table.

Returns: If the default route is set, a pointer to that Ipv4RoutingTableEntry is returned, otherwise an empty routing table entry is returned. If multiple default routes exist, the one with lowest metric is returned.

See also: Ipv4RoutingTableEntry

Definition at line 381 of file ipv4-static-routing.cc.

References ns3::Ipv4Mask::GetPrefixLength(), m_networkRoutes, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ GetMetric()

uint32_t ns3::Ipv4StaticRouting::GetMetric ( uint32_t index ) const

Get a metric for route from the static unicast routing table.

Parameters

index The index (into the routing table) of the route to retrieve.

Returns: If route is set, the metric is returned. If not, an infinity metric (0xffffffff) is returned

Definition at line 434 of file ipv4-static-routing.cc.

References m_networkRoutes, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by PrintRoutingTable().

Here is the caller graph for this function:

◆ GetMulticastRoute()

Ipv4MulticastRoutingTableEntry ns3::Ipv4StaticRouting::GetMulticastRoute ( uint32_t i ) const

Get a route from the static multicast routing table.

Externally, the multicast static routing table appears simply as a table with n entries.

Parameters

i	The index (into the routing table) of the multicast route to retrieve.

Returns: If route i is set, a pointer to that Ipv4MulticastRoutingTableEntry is returned, otherwise a zero pointer is returned.

See also: Ipv4MulticastRoutingTableEntry; Ipv4StaticRouting::RemoveRoute

Definition at line 166 of file ipv4-static-routing.cc.

References m_multicastRoutes, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

◆ GetNMulticastRoutes()

uint32_t ns3::Ipv4StaticRouting::GetNMulticastRoutes ( ) const

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

Warning: The default multicast route counts as one of the routes.

Returns: number of entries

Definition at line 159 of file ipv4-static-routing.cc.

References m_multicastRoutes, and NS_LOG_FUNCTION.

◆ GetNRoutes()

uint32_t ns3::Ipv4StaticRouting::GetNRoutes ( ) const

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.

Returns: number of entries

Definition at line 374 of file ipv4-static-routing.cc.

References m_networkRoutes, and NS_LOG_FUNCTION.

Referenced by PrintRoutingTable().

Here is the caller graph for this function:

◆ GetRoute()

Ipv4RoutingTableEntry ns3::Ipv4StaticRouting::GetRoute ( uint32_t i ) const

Get a route from the static unicast routing table.

Externally, the unicast static routing table appears simply as a table with n entries.

Parameters

i	The index (into the routing table) of the route to retrieve.

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

See also: Ipv4RoutingTableEntry; Ipv4StaticRouting::RemoveRoute

Definition at line 416 of file ipv4-static-routing.cc.

References m_networkRoutes, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by PrintRoutingTable().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::Ipv4StaticRouting::GetTypeId ( void )

static

The interface Id associated with this class.

Returns: type identifier

Definition at line 51 of file ipv4-static-routing.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ LookupRoute()

bool ns3::Ipv4StaticRouting::LookupRoute	(	const Ipv4RoutingTableEntry &	route,
		uint32_t	metric
	)

private

Checks if a route is already present in the forwarding table.

Parameters

route	route
metric	metric of route

Returns: true if the route/metric is already in the forwarding table

Definition at line 225 of file ipv4-static-routing.cc.

References ns3::Ipv4RoutingTableEntry::GetDest(), ns3::Ipv4RoutingTableEntry::GetDestNetworkMask(), ns3::Ipv4RoutingTableEntry::GetGateway(), ns3::Ipv4RoutingTableEntry::GetInterface(), and m_networkRoutes.

Referenced by AddNetworkRouteTo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LookupStatic() [1/2]

Ptr< Ipv4Route > ns3::Ipv4StaticRouting::LookupStatic	(	Ipv4Address	dest,
		Ptr< NetDevice >	oif = `nullptr`
	)

private

Lookup in the forwarding table for destination.

Parameters

dest	destination address
oif	output interface if any (put 0 otherwise)

Returns: Ipv4Route to route the packet to reach dest address

Definition at line 243 of file ipv4-static-routing.cc.

References ns3::Ipv4RoutingTableEntry::GetDest(), ns3::Ipv4RoutingTableEntry::GetGateway(), ns3::Ipv4RoutingTableEntry::GetInterface(), ns3::Ipv4Mask::GetPrefixLength(), ns3::Ipv4Address::GetZero(), ns3::Ipv4Address::IsLocalMulticast(), ns3::Ipv4Mask::IsMatch(), m_ipv4, m_networkRoutes, NS_ASSERT_MSG, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by RouteInput(), and RouteOutput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LookupStatic() [2/2]

Ptr< Ipv4MulticastRoute > ns3::Ipv4StaticRouting::LookupStatic	(	Ipv4Address	origin,
		Ipv4Address	group,
		uint32_t	interface
	)

private

Lookup in the multicast forwarding table for destination.

Parameters

origin	source address
group	group multicast address
interface	interface index

Returns: Ipv4MulticastRoute to route the packet to reach dest address

Definition at line 326 of file ipv4-static-routing.cc.

References ns3::Ipv4MulticastRoutingTableEntry::GetGroup(), ns3::Ipv4MulticastRoutingTableEntry::GetInputInterface(), ns3::Ipv4MulticastRoutingTableEntry::GetNOutputInterfaces(), ns3::Ipv4MulticastRoutingTableEntry::GetOrigin(), ns3::Ipv4MulticastRoutingTableEntry::GetOutputInterface(), ns3::Ipv4::IF_ANY, m_multicastRoutes, ns3::Ipv4MulticastRoute::MAX_TTL, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Here is the call graph for this function:

◆ NotifyAddAddress()

void ns3::Ipv4StaticRouting::NotifyAddAddress	(	uint32_t	interface,
		Ipv4InterfaceAddress	address
	)

overridevirtual

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.

Definition at line 645 of file ipv4-static-routing.cc.

References AddNetworkRouteTo(), first::address, m_ipv4, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ NotifyInterfaceDown()

void ns3::Ipv4StaticRouting::NotifyInterfaceDown ( uint32_t interface )

overridevirtual

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.

Definition at line 626 of file ipv4-static-routing.cc.

References m_networkRoutes, and NS_LOG_FUNCTION.

Referenced by SetIpv4().

Here is the caller graph for this function:

◆ NotifyInterfaceUp()

void ns3::Ipv4StaticRouting::NotifyInterfaceUp ( uint32_t interface )

overridevirtual

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.

Definition at line 605 of file ipv4-static-routing.cc.

References AddNetworkRouteTo(), ns3::Ipv4Mask::GetOnes(), m_ipv4, and NS_LOG_FUNCTION.

Referenced by SetIpv4().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ NotifyRemoveAddress()

void ns3::Ipv4StaticRouting::NotifyRemoveAddress	(	uint32_t	interface,
		Ipv4InterfaceAddress	address
	)

overridevirtual

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.

Definition at line 662 of file ipv4-static-routing.cc.

References first::address, m_ipv4, m_networkRoutes, and NS_LOG_FUNCTION.

◆ PrintRoutingTable()

void ns3::Ipv4StaticRouting::PrintRoutingTable	(	Ptr< OutputStreamWrapper >	stream,
		Time::Unit	unit = `Time::S`
	)		const

overridevirtual

Print the Routing Table entries.

Parameters

stream	The ostream the Routing table is printed to
unit	The time unit to be used in the report

Implements ns3::Ipv4RoutingProtocol.

Definition at line 710 of file ipv4-static-routing.cc.

References ns3::Time::As(), ns3::Names::FindName(), ns3::Ipv4RoutingTableEntry::GetDest(), ns3::Ipv4RoutingTableEntry::GetDestNetworkMask(), ns3::Ipv4RoutingTableEntry::GetGateway(), ns3::Ipv4RoutingTableEntry::GetInterface(), GetMetric(), GetNRoutes(), GetRoute(), ns3::OutputStreamWrapper::GetStream(), ns3::Ipv4RoutingTableEntry::IsGateway(), ns3::Ipv4RoutingTableEntry::IsHost(), m_ipv4, ns3::Now(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ RemoveMulticastRoute() [1/2]

bool ns3::Ipv4StaticRouting::RemoveMulticastRoute	(	Ipv4Address	origin,
		Ipv4Address	group,
		uint32_t	inputInterface
	)

Remove a route from the static multicast routing table.

Externally, the multicast static routing table appears simply as a table with n entries. This method causes the multicast routing table to be searched for the first route that matches the parameters and removes it.

Wildcards may be provided to this function, but the wildcards are used to exactly match wildcards in the routes (see AddMulticastRoute). That is, calling RemoveMulticastRoute with the origin set to "0.0.0.0" will not remove routes with any address in the origin, but will only remove routes with "0.0.0.0" set as the the origin.

Parameters

origin	The IP address specified as the origin of packets for the route.
group	The IP address specified as the multicast group address of the route.
inputInterface	The network interface index specified as the expected input interface for the route.

Returns: true if a route was found and removed, false otherwise.

See also: Ipv4MulticastRoutingTableEntry; Ipv4StaticRouting::AddMulticastRoute

Definition at line 188 of file ipv4-static-routing.cc.

References ns3::Ipv4MulticastRoutingTableEntry::GetGroup(), ns3::Ipv4MulticastRoutingTableEntry::GetInputInterface(), ns3::Ipv4MulticastRoutingTableEntry::GetOrigin(), m_multicastRoutes, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ RemoveMulticastRoute() [2/2]

void ns3::Ipv4StaticRouting::RemoveMulticastRoute ( uint32_t index )

Remove a route from the static multicast routing table.

Externally, the multicast static routing table appears simply as a table with n entries.

Parameters

index The index (into the multicast routing table) of the route to remove.

See also: Ipv4RoutingTableEntry; Ipv4StaticRouting::GetRoute; Ipv4StaticRouting::AddRoute

Definition at line 208 of file ipv4-static-routing.cc.

References m_multicastRoutes, and NS_LOG_FUNCTION.

◆ RemoveRoute()

void ns3::Ipv4StaticRouting::RemoveRoute ( uint32_t i )

Remove a route from the static unicast routing table.

Externally, the unicast static routing table appears simply as a table with n entries.

Parameters

i	The index (into the routing table) of the route to remove.

See also: Ipv4RoutingTableEntry; Ipv4StaticRouting::GetRoute; Ipv4StaticRouting::AddRoute

Definition at line 452 of file ipv4-static-routing.cc.

References m_networkRoutes, NS_ASSERT, and NS_LOG_FUNCTION.

◆ RouteInput()

bool ns3::Ipv4StaticRouting::RouteInput	(	Ptr< const Packet >	p,
		const Ipv4Header &	header,
		Ptr< const NetDevice >	idev,
		const UnicastForwardCallback &	ucb,
		const MulticastForwardCallback &	mcb,
		const LocalDeliverCallback &	lcb,
		const ErrorCallback &	ecb
	)

overridevirtual

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.

Definition at line 503 of file ipv4-static-routing.cc.

References ns3::Socket::ERROR_NOROUTETOHOST, ns3::Ipv4Header::GetDestination(), ns3::Ipv4Header::GetSource(), ns3::Ipv4Address::IsMulticast(), ns3::Callback< R, UArgs >::IsNull(), LookupStatic(), m_ipv4, NS_ASSERT, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Here is the call graph for this function:

◆ RouteOutput()

Ptr< Ipv4Route > ns3::Ipv4StaticRouting::RouteOutput	(	Ptr< Packet >	p,
		const Ipv4Header &	header,
		Ptr< NetDevice >	oif,
		Socket::SocketErrno &	sockerr
	)

overridevirtual

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

The header input parameter may have an uninitialized value for the source address, but the destination address should always be properly set by the caller.

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.

Definition at line 470 of file ipv4-static-routing.cc.

References ns3::Socket::ERROR_NOROUTETOHOST, ns3::Socket::ERROR_NOTERROR, ns3::Ipv4Header::GetDestination(), ns3::Ipv4Address::IsMulticast(), LookupStatic(), NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Here is the call graph for this function:

◆ SetDefaultMulticastRoute()

void ns3::Ipv4StaticRouting::SetDefaultMulticastRoute ( uint32_t outputInterface )

Add a default multicast route to the static routing table.

This is the multicast equivalent of the unicast version SetDefaultRoute. We tell the routing system what to do in the case where a specific route to a destination multicast group is not found. The system forwards packets out the specified interface in the hope that "something out there" knows better how to route the packet. This method is only used in initially sending packets off of a host. The default multicast route is not consulted during forwarding – exact routes must be specified using AddMulticastRoute for that case.

Since we're basically sending packets to some entity we think may know better what to do, we don't pay attention to "subtleties" like origin address, nor do we worry about forwarding out multiple interfaces. If the default multicast route is set, it is returned as the selected route from LookupStatic irrespective of origin or multicast group if another specific route is not found.

Parameters

outputInterface The network interface index used to specify where to send packets in the case of unknown routes.

See also: Ipv4Address

Definition at line 148 of file ipv4-static-routing.cc.

References ns3::Ipv4RoutingTableEntry::CreateNetworkRouteTo(), m_networkRoutes, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ SetDefaultRoute()

void ns3::Ipv4StaticRouting::SetDefaultRoute	(	Ipv4Address	nextHop,
		uint32_t	interface,
		uint32_t	metric = `0`
	)

Add a default route to the static routing table.

This method tells the routing system what to do in the case where a specific route to a destination is not found. The system forwards packets to the specified node in the hope that it knows better how to route the packet.

If the default route is set, it is returned as the selected route from LookupStatic irrespective of destination address if no specific route is found.

Parameters

nextHop	The Ipv4Address to send packets to in the hope that they will be forwarded correctly.
interface	The network interface index used to send packets.
metric	Metric of route in case of multiple routes to same destination

See also: Ipv4Address; Ipv4StaticRouting::Lookup

Definition at line 122 of file ipv4-static-routing.cc.

References AddNetworkRouteTo(), ns3::Ipv4Mask::GetZero(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ SetIpv4()

void ns3::Ipv4StaticRouting::SetIpv4 ( Ptr< Ipv4 > ipv4 )

overridevirtual

Parameters

ipv4	the ipv4 object this routing protocol is being associated with

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

Implements ns3::Ipv4RoutingProtocol.

Definition at line 690 of file ipv4-static-routing.cc.

References nsclick-simple-lan::ipv4, m_ipv4, NotifyInterfaceDown(), NotifyInterfaceUp(), NS_ASSERT, and NS_LOG_FUNCTION.

Here is the call graph for this function:

Member Data Documentation

◆ m_ipv4

Ptr<Ipv4> ns3::Ipv4StaticRouting::m_ipv4

private

Ipv4 reference.

Definition at line 422 of file ipv4-static-routing.h.

Referenced by DoDispose(), LookupStatic(), NotifyAddAddress(), NotifyInterfaceUp(), NotifyRemoveAddress(), PrintRoutingTable(), RouteInput(), and SetIpv4().

◆ m_multicastRoutes

MulticastRoutes ns3::Ipv4StaticRouting::m_multicastRoutes

private

the forwarding table for multicast.

Definition at line 417 of file ipv4-static-routing.h.

Referenced by AddMulticastRoute(), DoDispose(), GetMulticastRoute(), GetNMulticastRoutes(), LookupStatic(), and RemoveMulticastRoute().

◆ m_networkRoutes

NetworkRoutes ns3::Ipv4StaticRouting::m_networkRoutes

private

the forwarding table for network.

Definition at line 412 of file ipv4-static-routing.h.

Referenced by AddNetworkRouteTo(), DoDispose(), GetDefaultRoute(), GetMetric(), GetNRoutes(), GetRoute(), LookupRoute(), LookupStatic(), NotifyInterfaceDown(), NotifyRemoveAddress(), RemoveRoute(), and SetDefaultMulticastRoute().

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

src/internet/model/ipv4-static-routing.h
src/internet/model/ipv4-static-routing.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ MulticastRoutes

◆ MulticastRoutesCI

◆ MulticastRoutesI

◆ NetworkRoutes

◆ NetworkRoutesCI

◆ NetworkRoutesI

Constructor & Destructor Documentation

◆ Ipv4StaticRouting()

◆ ~Ipv4StaticRouting()

Member Function Documentation

◆ AddHostRouteTo() [1/2]

◆ AddHostRouteTo() [2/2]

◆ AddMulticastRoute()

◆ AddNetworkRouteTo() [1/2]

◆ AddNetworkRouteTo() [2/2]

◆ DoDispose()

◆ GetDefaultRoute()

◆ GetMetric()

◆ GetMulticastRoute()

◆ GetNMulticastRoutes()

◆ GetNRoutes()

◆ GetRoute()

◆ GetTypeId()

◆ LookupRoute()

◆ LookupStatic() [1/2]

◆ LookupStatic() [2/2]

◆ NotifyAddAddress()

◆ NotifyInterfaceDown()

◆ NotifyInterfaceUp()

◆ NotifyRemoveAddress()

◆ PrintRoutingTable()

◆ RemoveMulticastRoute() [1/2]

◆ RemoveMulticastRoute() [2/2]

◆ RemoveRoute()

◆ RouteInput()

◆ RouteOutput()

◆ SetDefaultMulticastRoute()

◆ SetDefaultRoute()

◆ SetIpv4()

Member Data Documentation

◆ m_ipv4

◆ m_multicastRoutes

◆ m_networkRoutes