IPv4 dummy routing class (A) More...

Inheritance diagram for Ipv4ARouting:

Collaboration diagram for Ipv4ARouting:

Public Member Functions
void	NotifyAddAddress (uint32_t interface, Ipv4InterfaceAddress address)

void	NotifyInterfaceDown (uint32_t interface)

void	NotifyInterfaceUp (uint32_t interface)

void	NotifyRemoveAddress (uint32_t interface, Ipv4InterfaceAddress address)

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

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

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

void	SetIpv4 (Ptr< Ipv4 > ipv4)

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

virtual	~Object ()
	Destructor. More...

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

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

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

virtual TypeId	GetInstanceTypeId (void) const
	Get the most derived TypeId for this 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...

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

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

bool	IsInitialized (void) 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 (void) const
	Get the reference count of the object. More...

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

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

void	Unref (void) 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 erros. 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...

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

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

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

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

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

virtual void	DoDispose (void)
	Destructor implementation. More...

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

virtual void	NotifyNewAggregate (void)
	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 (void)
	Notifier called once the ObjectBase is fully constructed. More...

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

Detailed Description

IPv4 dummy routing class (A)

Definition at line 32 of file ipv4-list-routing-test-suite.cc.

Member Function Documentation

◆ NotifyAddAddress()

void Ipv4ARouting::NotifyAddAddress	(	uint32_t	interface,
		Ipv4InterfaceAddress	address
	)

inlinevirtual

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 40 of file ipv4-list-routing-test-suite.cc.

◆ NotifyInterfaceDown()

void Ipv4ARouting::NotifyInterfaceDown ( uint32_t interface )

inlinevirtual

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 39 of file ipv4-list-routing-test-suite.cc.

◆ NotifyInterfaceUp()

void Ipv4ARouting::NotifyInterfaceUp ( uint32_t interface )

inlinevirtual

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 38 of file ipv4-list-routing-test-suite.cc.

◆ NotifyRemoveAddress()

void Ipv4ARouting::NotifyRemoveAddress	(	uint32_t	interface,
		Ipv4InterfaceAddress	address
	)

inlinevirtual

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 41 of file ipv4-list-routing-test-suite.cc.

◆ PrintRoutingTable()

void Ipv4ARouting::PrintRoutingTable	(	Ptr< OutputStreamWrapper >	stream,
		Time::Unit	unit
	)		const

inlinevirtual

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 43 of file ipv4-list-routing-test-suite.cc.

◆ RouteInput()

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

inlinevirtual

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 35 of file ipv4-list-routing-test-suite.cc.

◆ RouteOutput()

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

inlinevirtual

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