Interface for L2 mesh routing protocol and mesh point communication. More...

#include <mesh-l2-routing-protocol.h>

Inheritance diagram for ns3::MeshL2RoutingProtocol:

Collaboration diagram for ns3::MeshL2RoutingProtocol:

Public Types
typedef Callback< void, bool, Ptr< Packet >, Mac48Address, Mac48Address, uint16_t, uint32_t >	RouteReplyCallback
	Callback to be invoked when route discovery procedure is completed. More...

Public Member Functions
virtual	~MeshL2RoutingProtocol ()
	virtual D-tor for subclasses More...

Ptr< MeshPointDevice >	GetMeshPoint () const
	Each mesh protocol must be installed on the mesh point to work. More...

virtual bool	RemoveRoutingStuff (uint32_t fromIface, const Mac48Address source, const Mac48Address destination, Ptr< Packet > packet, uint16_t &protocolType)=0
	When packet is ready to go to upper layer, protocol must remove all its information: tags, header, etc. More...

virtual bool	RequestRoute (uint32_t sourceIface, const Mac48Address source, const Mac48Address destination, Ptr< const Packet > packet, uint16_t protocolType, RouteReplyCallback routeReply)=0
	Request routing information, all packets must go through this request. More...

void	SetMeshPoint (Ptr< MeshPointDevice > mp)
	Set host mesh point, analog of SetNode (...) methods for upper layer protocols. More...

Public Member Functions inherited from ns3::Object
	Object ()

virtual	~Object ()

void	AggregateObject (Ptr< Object > other)

void	Dispose (void)
	Run the DoDispose methods of this object and all the objects aggregated to it. More...

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)
	This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...

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

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

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

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. 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

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 ()
	Never forget to support NS3 object model. More...

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

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

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

Protected Attributes
Ptr< MeshPointDevice >	m_mp
	Host mesh point. More...

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

virtual void	DoDispose (void)
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...

virtual void	DoInitialize (void)
	This method is called only once by Object::Initialize. More...

virtual void	NotifyNewAggregate (void)
	This method is invoked whenever two sets of objects are aggregated together. More...

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

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

Detailed Description

Interface for L2 mesh routing protocol and mesh point communication.

Every mesh routing protocol must implement this interface. Each mesh point (MeshPointDevice) is supposed to know single L2RoutingProtocol to work with, see MeshPointDevice::SetRoutingProtocol ().

This interface is similar to ipv4 routing protocol base class.

Config Paths

ns3::MeshL2RoutingProtocol is accessible through the following paths with Config::Set and Config::Connect:

/NodeList/[i]/DeviceList/[i]/$ns3::MeshPointDevice/RoutingProtocol

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

Definition at line 44 of file mesh-l2-routing-protocol.h.

Member Typedef Documentation

typedef Callback<void, bool, Ptr<Packet>, Mac48Address, Mac48Address, uint16_t, uint32_t > ns3::MeshL2RoutingProtocol::RouteReplyCallback

Callback to be invoked when route discovery procedure is completed.

Parameters

flag	indicating whether a route was actually found and all needed information is added to the packet successfully
packet	for which the route was resolved. All routing information for MAC layer must be stored in proper tags (like in case of HWMP, when WifiMacHeader needs address of next hop), or must be added as a packet header (if MAC does not need any additional information). So, the packet is returned back to MeshPointDevice looks like a pure packet with ethernet header (i.e data + src +dst + protocol). The only special information addressed to MeshPointDevice is an outcoming interface ID.
src	source address of the packet
dst	destination address of the packet
protocol	ethernet 'Protocol' field, needed to form a proper MAC-layer header
uint32_t	outcoming interface to use or 0xffffffff if packet should be sent by ALL interfaces

Definition at line 80 of file mesh-l2-routing-protocol.h.

Constructor & Destructor Documentation

ns3::MeshL2RoutingProtocol::~MeshL2RoutingProtocol ( )

virtual

virtual D-tor for subclasses

Definition at line 41 of file mesh-l2-routing-protocol.cc.

References m_mp.

Member Function Documentation

Ptr< MeshPointDevice > ns3::MeshL2RoutingProtocol::GetMeshPoint ( ) const

Each mesh protocol must be installed on the mesh point to work.

Definition at line 53 of file mesh-l2-routing-protocol.cc.

References m_mp.

Referenced by ns3::dot11s::HwmpProtocol::ForwardUnicast(), and ns3::dot11s::HwmpProtocol::RequestRoute().

Here is the caller graph for this function:

TypeId ns3::MeshL2RoutingProtocol::GetTypeId ( void )

static

Never forget to support NS3 object model.

Definition at line 34 of file mesh-l2-routing-protocol.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

virtual bool ns3::MeshL2RoutingProtocol::RemoveRoutingStuff	(	uint32_t	fromIface,
		const Mac48Address	source,
		const Mac48Address	destination,
		Ptr< Packet >	packet,
		uint16_t &	protocolType
	)

pure virtual

When packet is ready to go to upper layer, protocol must remove all its information: tags, header, etc.

So, MeshPointDevice must call this method when passing a packet to upper layer.

Returns: true if packet shall not be dropped, false otherwise.

Parameters

fromIface	the incoming interface of the packet
source	source address
destination	destination address
packet	the packet to be handled
protocolType	protocol ID, needed to form a proper MAC-layer header

Attention: protocol type is passed by reference, because may be changed

Implemented in ns3::flame::FlameProtocol, and ns3::dot11s::HwmpProtocol.

virtual bool ns3::MeshL2RoutingProtocol::RequestRoute	(	uint32_t	sourceIface,
		const Mac48Address	source,
		const Mac48Address	destination,
		Ptr< const Packet >	packet,
		uint16_t	protocolType,
		RouteReplyCallback	routeReply
	)

pure virtual

Request routing information, all packets must go through this request.

Note that route discovery works async. – RequestRoute returns immediately, while reply callback will be called when routing information will be available.

Returns: true if valid route is already known

Parameters

sourceIface	the incoming interface of the packet
source	source address
destination	destination address
packet	the packet to be resolved (needed the whole packet, because routing information is added as tags or headers). The packet will be returned to reply callback.
protocolType	protocol ID, needed to form a proper MAC-layer header
routeReply	callback to be invoked after route discovery procedure, supposed to really send packet using routing information.