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 < Ipv4Route >, Ptr< const Packet >, const Ipv4Header & >	UnicastForwardCallback
typedef Callback< void, Ptr < Ipv4MulticastRoute >, Ptr < const Packet >, const Ipv4Header & >	MulticastForwardCallback
typedef Callback< void, Ptr < const Packet >, const Ipv4Header &, uint32_t >	LocalDeliverCallback
typedef Callback< void, Ptr < const Packet >, const Ipv4Header &, Socket::SocketErrno >	ErrorCallback
Public Member Functions
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 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 void	NotifyInterfaceUp (uint32_t interface)=0
virtual void	NotifyInterfaceDown (uint32_t interface)=0
virtual void	NotifyAddAddress (uint32_t interface, Ipv4InterfaceAddress address)=0
virtual void	NotifyRemoveAddress (uint32_t interface, Ipv4InterfaceAddress address)=0
virtual void	SetIpv4 (Ptr< Ipv4 > ipv4)=0
Static Public Member Functions
static TypeId	GetTypeId (void)
	This method returns the TypeId associated to ns3::Ipv4RoutingProtocol.

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

Member Function Documentation

static TypeId ns3::Ipv4RoutingProtocol::GetTypeId ( void ) [static]

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

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

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

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

Reimplemented from ns3::Object.

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

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::aodv::RoutingProtocol, ns3::Ipv4GlobalRouting, ns3::Ipv4ListRouting, and ns3::Ipv4StaticRouting.

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::aodv::RoutingProtocol, ns3::Ipv4GlobalRouting, ns3::Ipv4ListRouting, and ns3::Ipv4StaticRouting.

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::aodv::RoutingProtocol, ns3::Ipv4GlobalRouting, ns3::Ipv4ListRouting, and ns3::Ipv4StaticRouting.

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::aodv::RoutingProtocol, ns3::Ipv4GlobalRouting, ns3::Ipv4ListRouting, and ns3::Ipv4StaticRouting.

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::aodv::RoutingProtocol, ns3::Ipv4GlobalRouting, ns3::Ipv4ListRouting, and ns3::Ipv4StaticRouting.

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

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

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

virtual void ns3::Ipv4RoutingProtocol::SetIpv4 ( Ptr< Ipv4 > ipv4 ) [pure virtual]

Parameters:

ipv4

the ipv4 object this routing protocol is being associated with

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

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

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

src/node/ipv4-routing-protocol.h
doc/introspected-doxygen.h

ns3::Ipv4RoutingProtocol Class Reference [Ipv4RoutingProtocol]

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

ns3::Ipv4RoutingProtocol Class Reference
[Ipv4RoutingProtocol]