A Discrete-Event Network Simulator
API
ns3::MeshL2RoutingProtocol Class Referenceabstract

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< MeshPointDeviceGetMeshPoint () 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 ()
 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<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::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)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (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...
 

Static Public Member Functions

static TypeId GetTypeId ()
 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 Attributes

Ptr< MeshPointDevicem_mp
 Host mesh point. More...
 

Additional Inherited Members

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

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.
Size of this type is 40 bytes (on a 64-bit architecture).

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

Member Typedef Documentation

◆ RouteReplyCallback

Callback to be invoked when route discovery procedure is completed.

Parameters
flagindicating whether a route was actually found and all needed information is added to the packet successfully
packetfor 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.
srcsource address of the packet
dstdestination address of the packet
protocolethernet 'Protocol' field, needed to form a proper MAC-layer header
uint32_toutcoming interface to use or 0xffffffff if packet should be sent by ALL interfaces

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

Constructor & Destructor Documentation

◆ ~MeshL2RoutingProtocol()

ns3::MeshL2RoutingProtocol::~MeshL2RoutingProtocol ( )
virtual

virtual D-tor for subclasses

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

References m_mp.

Member Function Documentation

◆ GetMeshPoint()

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

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

Returns
the mesh point device

Definition at line 54 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:

◆ GetTypeId()

TypeId ns3::MeshL2RoutingProtocol::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ RemoveRoutingStuff()

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
fromIfacethe incoming interface of the packet
sourcesource address
destinationdestination address
packetthe packet to be handled
protocolTypeprotocol 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.

◆ RequestRoute()

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
sourceIfacethe incoming interface of the packet
sourcesource address
destinationdestination address
packetthe 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.
protocolTypeprotocol ID, needed to form a proper MAC-layer header
routeReplycallback to be invoked after route discovery procedure, supposed to really send packet using routing information.

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

◆ SetMeshPoint()

void ns3::MeshL2RoutingProtocol::SetMeshPoint ( Ptr< MeshPointDevice mp)

Set host mesh point, analog of SetNode (...) methods for upper layer protocols.

Parameters
mpthe mesh point device

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

References m_mp.

Member Data Documentation

◆ m_mp


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