Abstract base class for IPv4 routing protocols. More...

#include <ipv4-routing-protocol.h>

Inheritance diagram for ns3::Ipv4RoutingProtocol:

Collaboration diagram for ns3::Ipv4RoutingProtocol:

Public Types
typedef Callback< void, Ptr < const Packet >, const Ipv4Header &, Socket::SocketErrno >	ErrorCallback
typedef Callback< void, Ptr < const Packet >, const Ipv4Header &, uint32_t >	LocalDeliverCallback
typedef Callback< void, Ptr < Ipv4MulticastRoute >, Ptr < const Packet >, const Ipv4Header & >	MulticastForwardCallback
typedef Callback< void, Ptr < Ipv4Route >, Ptr< const Packet >, const Ipv4Header & >	UnicastForwardCallback

Public Member Functions
virtual void	NotifyAddAddress (uint32_t interface, Ipv4InterfaceAddress address)=0
virtual void	NotifyInterfaceDown (uint32_t interface)=0
virtual void	NotifyInterfaceUp (uint32_t interface)=0
virtual void	NotifyRemoveAddress (uint32_t interface, Ipv4InterfaceAddress address)=0
virtual void	PrintRoutingTable (Ptr< OutputStreamWrapper > stream) const =0
	Print the Routing Table entries.
virtual bool	RouteInput (Ptr< const Packet > p, const Ipv4Header &header, Ptr< const NetDevice > idev, UnicastForwardCallback ucb, MulticastForwardCallback mcb, LocalDeliverCallback lcb, ErrorCallback ecb)=0
	Route an input packet (to be forwarded or locally delivered)
virtual Ptr< Ipv4Route >	RouteOutput (Ptr< Packet > p, const Ipv4Header &header, Ptr< NetDevice > oif, Socket::SocketErrno &sockerr)=0
	Query routing cache for an existing route, for an outbound packet.
virtual void	SetIpv4 (Ptr< Ipv4 > ipv4)=0
Public Member Functions inherited from ns3::Object
	Object ()
virtual	~Object ()
void	AggregateObject (Ptr< Object > other)
void	Dispose (void)
AggregateIterator	GetAggregateIterator (void) const
virtual TypeId	GetInstanceTypeId (void) const
template<typename T >
Ptr< T >	GetObject (void) const
template<typename T >
Ptr< T >	GetObject (TypeId tid) const
void	Initialize (void)
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	SimpleRefCount (const SimpleRefCount &o)
uint32_t	GetReferenceCount (void) const
SimpleRefCount &	operator= (const SimpleRefCount &o)
void	Ref (void) const
void	Unref (void) const
Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
void	GetAttribute (std::string name, AttributeValue &value) const
bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
void	SetAttribute (std::string name, const AttributeValue &value)
bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions
static TypeId	GetTypeId (void)

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
virtual void	DoDispose (void)
virtual void	DoInitialize (void)
virtual void	NotifyNewAggregate (void)

Detailed Description

Abstract base class for IPv4 routing protocols.

Defines two virtual functions for packet routing and forwarding. The first, RouteOutput(), is used for locally originated packets, and the second, RouteInput(), is used for forwarding and/or delivering received packets. Also defines the signatures of four callbacks used in RouteInput().

Doxygen introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.

Definition at line 50 of file ipv4-routing-protocol.h.

Member Typedef Documentation

typedef Callback<void, Ptr<const Packet>, const Ipv4Header &, Socket::SocketErrno > ns3::Ipv4RoutingProtocol::ErrorCallback

Definition at line 58 of file ipv4-routing-protocol.h.

typedef Callback<void, Ptr<const Packet>, const Ipv4Header &, uint32_t > ns3::Ipv4RoutingProtocol::LocalDeliverCallback

Definition at line 57 of file ipv4-routing-protocol.h.

typedef Callback<void, Ptr<Ipv4MulticastRoute>, Ptr<const Packet>, const Ipv4Header &> ns3::Ipv4RoutingProtocol::MulticastForwardCallback

Definition at line 56 of file ipv4-routing-protocol.h.

typedef Callback<void, Ptr<Ipv4Route>, Ptr<const Packet>, const Ipv4Header &> ns3::Ipv4RoutingProtocol::UnicastForwardCallback

Definition at line 55 of file ipv4-routing-protocol.h.

Member Function Documentation

TypeId ns3::Ipv4RoutingProtocol::GetTypeId ( void )

static

Reimplemented from ns3::Object.

Reimplemented in ns3::olsr::RoutingProtocol, ns3::Ipv4GlobalRouting, ns3::Ipv4StaticRouting, ns3::Ipv4NixVectorRouting, ns3::dsdv::RoutingProtocol, ns3::aodv::RoutingProtocol, and ns3::Ipv4ListRouting.

Definition at line 30 of file ipv4-routing-protocol.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

virtual void ns3::Ipv4RoutingProtocol::NotifyAddAddress	(	uint32_t	interface,
		Ipv4InterfaceAddress	address
	)

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

Implemented in ns3::Ipv4GlobalRouting, ns3::Ipv4ListRouting, ns3::Ipv4StaticRouting, ns3::dsdv::RoutingProtocol, ns3::aodv::RoutingProtocol, Ipv4BRouting, and Ipv4ARouting.

Referenced by ns3::Ipv4L3Protocol::AddAddress().

Here is the caller graph for this function:

virtual void ns3::Ipv4RoutingProtocol::NotifyInterfaceDown ( uint32_t interface )

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

Implemented in ns3::Ipv4GlobalRouting, ns3::Ipv4ListRouting, ns3::Ipv4StaticRouting, ns3::dsdv::RoutingProtocol, ns3::aodv::RoutingProtocol, Ipv4BRouting, and Ipv4ARouting.

Referenced by ns3::Ipv4L3Protocol::SetDown().

Here is the caller graph for this function:

virtual void ns3::Ipv4RoutingProtocol::NotifyInterfaceUp ( uint32_t interface )

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

Implemented in ns3::Ipv4GlobalRouting, ns3::Ipv4ListRouting, ns3::Ipv4StaticRouting, ns3::dsdv::RoutingProtocol, ns3::aodv::RoutingProtocol, Ipv4BRouting, and Ipv4ARouting.

Referenced by ns3::Ipv4L3Protocol::SetUp(), and ns3::Ipv4L3Protocol::SetupLoopback().

Here is the caller graph for this function:

virtual void ns3::Ipv4RoutingProtocol::NotifyRemoveAddress	(	uint32_t	interface,
		Ipv4InterfaceAddress	address
	)

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

Implemented in ns3::Ipv4GlobalRouting, ns3::Ipv4ListRouting, ns3::Ipv4StaticRouting, ns3::dsdv::RoutingProtocol, ns3::aodv::RoutingProtocol, Ipv4BRouting, and Ipv4ARouting.

Referenced by ns3::Ipv4L3Protocol::RemoveAddress().

Here is the caller graph for this function:

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

pure virtual

Print the Routing Table entries.

Parameters

stream the ostream the Routing table is printed to

Implemented in ns3::Ipv4GlobalRouting, ns3::Ipv4ListRouting, ns3::Ipv4StaticRouting, ns3::aodv::RoutingProtocol, ns3::dsdv::RoutingProtocol, Ipv4BRouting, and Ipv4ARouting.

Referenced by ns3::AnimationInterface::GetIpv4RoutingTable().

Here is the caller graph for this function:

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

pure 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

Implemented in ns3::Ipv4GlobalRouting, ns3::Ipv4ListRouting, ns3::Ipv4StaticRouting, ns3::aodv::RoutingProtocol, Ipv4BRouting, and Ipv4ARouting.

Referenced by ns3::Ipv4L3Protocol::Receive().

Here is the caller graph for this function:

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

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

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