#include <ipv4-nix-vector-routing.h>

Inheritance diagram for ns3::Ipv4NixVectorRouting:

Public Member Functions
void	FlushGlobalNixRoutingCache (void)
	Called when run-time link topology change occurs which iterates through the node list and flushes any nix vector caches.

void	SetNode (Ptr< Node > node)
	Set the Node pointer of the node for which this routing protocol is to be placed. More...

Public Member Functions inherited from ns3::Ipv4RoutingProtocol
virtual void	SetRepository (Ptr< Repository > repo)
	Set cognitive radio repository. More...

Public Member Functions inherited from ns3::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 (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
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)
	The Interface ID of the Global Router interface. More...

Static Public Member Functions inherited from ns3::Ipv4RoutingProtocol
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)

Private Member Functions
bool	BFS (uint32_t numberOfNodes, Ptr< Node > source, Ptr< Node > dest, std::vector< Ptr< Node > > &parentVector, Ptr< NetDevice > oif)

bool	BuildNixVector (const std::vector< Ptr< Node > > &parentVector, uint32_t source, uint32_t dest, Ptr< NixVector > nixVector)

bool	BuildNixVectorLocal (Ptr< NixVector > nixVector)

void	DoDispose (void)

uint32_t	FindNetDeviceForNixIndex (uint32_t nodeIndex, Ipv4Address &gatewayIp)

uint32_t	FindTotalNeighbors (void)

void	FlushIpv4RouteCache (void)

void	FlushNixCache (void)

void	GetAdjacentNetDevices (Ptr< NetDevice >, Ptr< Channel >, NetDeviceContainer &)

Ptr< Ipv4Route >	GetIpv4RouteInCache (Ipv4Address)

Ptr< NixVector >	GetNixVector (Ptr< Node >, Ipv4Address, Ptr< NetDevice >)

Ptr< NixVector >	GetNixVectorInCache (Ipv4Address)

Ptr< Node >	GetNodeByIp (Ipv4Address)

Ptr< BridgeNetDevice >	NetDeviceIsBridged (Ptr< NetDevice > nd) const

virtual void	NotifyAddAddress (uint32_t interface, Ipv4InterfaceAddress address)

virtual void	NotifyInterfaceDown (uint32_t interface)

virtual void	NotifyInterfaceUp (uint32_t interface)

virtual void	NotifyRemoveAddress (uint32_t interface, Ipv4InterfaceAddress address)

virtual void	PrintRoutingTable (Ptr< OutputStreamWrapper > stream) const
	Print the Routing Table entries. More...

void	ResetTotalNeighbors (void)

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

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

virtual void	SetIpv4 (Ptr< Ipv4 > ipv4)

Private Attributes
Ptr< Ipv4 >	m_ipv4

Ipv4RouteMap_t	m_ipv4RouteCache

NixMap_t	m_nixCache

Ptr< Node >	m_node

uint32_t	m_totalNeighbors

Additional Inherited Members
Public Types inherited from ns3::Ipv4RoutingProtocol
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

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)

virtual void	DoInitialize (void)

virtual void	NotifyNewAggregate (void)

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)

Detailed Description

Nix-vector routing protocol

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 49 of file ipv4-nix-vector-routing.h.

Member Function Documentation

void ns3::Ipv4NixVectorRouting::DoDispose ( void )

privatevirtual

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

Subclasses are expected to implement their real destruction code in an overriden 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 69 of file ipv4-nix-vector-routing.cc.

References ns3::Object::DoDispose(), and NS_LOG_FUNCTION_NOARGS.

TypeId ns3::Ipv4NixVectorRouting::GetTypeId ( void )

static

The Interface ID of the Global Router interface.

See Also: Object::GetObject ()

Definition at line 38 of file ipv4-nix-vector-routing.cc.

References ns3::TypeId::SetParent().

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

privatevirtual

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 717 of file ipv4-nix-vector-routing.cc.

References FlushGlobalNixRoutingCache().

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

privatevirtual

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 712 of file ipv4-nix-vector-routing.cc.

References FlushGlobalNixRoutingCache().

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

privatevirtual

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 707 of file ipv4-nix-vector-routing.cc.

References FlushGlobalNixRoutingCache().

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

privatevirtual

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 722 of file ipv4-nix-vector-routing.cc.

References FlushGlobalNixRoutingCache().

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

privatevirtual

Print the Routing Table entries.

Parameters

stream the ostream the Routing table is printed to

Implements ns3::Ipv4RoutingProtocol.

Definition at line 662 of file ipv4-nix-vector-routing.cc.

References ns3::Names::FindName(), and ns3::OutputStreamWrapper::GetStream().

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

privatevirtual

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 604 of file ipv4-nix-vector-routing.cc.

References ns3::NixVector::BitCount(), ns3::NixVector::ExtractNeighborIndex(), ns3::Ipv4Header::GetDestination(), ns3::Node::GetDevice(), ns3::Node::GetId(), NS_ASSERT, NS_LOG_FUNCTION_NOARGS, NS_LOG_LOGIC, ns3::Ipv4Route::SetDestination(), ns3::Ipv4Route::SetGateway(), ns3::Ipv4Route::SetOutputDevice(), and ns3::Ipv4Route::SetSource().

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

privatevirtual

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