ns-3
ns3::dot11s::HwmpProtocol Class Reference

Hybrid wireless mesh protocol – a routing protocol of IEEE 802.11s draft. More...

#include <hwmp-protocol.h>

Inheritance diagram for ns3::dot11s::HwmpProtocol:
Collaboration diagram for ns3::dot11s::HwmpProtocol:

List of all members.

Classes

struct  FailedDestination
 structure of unreachable destination - address and sequence number More...
struct  PathError
 Structure of path error: IePerr and list of receivers: interfaces and MAC address.
struct  PreqEvent
struct  QueuedPacket
 Packet waiting its routing information.
struct  Statistics

Public Member Functions

void DoDispose ()
bool RequestRoute (uint32_t sourceIface, const Mac48Address source, const Mac48Address destination, Ptr< const Packet > packet, uint16_t protocolType, RouteReplyCallback routeReply)
 Route request, inherited from MeshL2RoutingProtocol.
bool RemoveRoutingStuff (uint32_t fromIface, const Mac48Address source, const Mac48Address destination, Ptr< Packet > packet, uint16_t &protocolType)
 Cleanup packet from all tags.
bool Install (Ptr< MeshPointDevice >)
 Install HWMP on given mesh point.
void PeerLinkStatus (Mac48Address meshPontAddress, Mac48Address peerAddress, uint32_t interface, bool status)
void SetNeighboursCallback (Callback< std::vector< Mac48Address >, uint32_t > cb)
 This callback is used to obtain active neighbours on a given interface.
void Report (std::ostream &) const
 Statistics:
void ResetStats ()
Proactive PREQ mechanism:
void SetRoot ()
void UnsetRoot ()
- Public Member Functions inherited from ns3::MeshL2RoutingProtocol
virtual ~MeshL2RoutingProtocol ()
 virtual D-tor for subclasses
void SetMeshPoint (Ptr< MeshPointDevice > mp)
 Set host mesh point, analog of SetNode (...) methods for upper layer protocols.
Ptr< MeshPointDeviceGetMeshPoint () const
 Each mesh protocol must be installed on the mesh point to work.
- Public Member Functions inherited from ns3::Object
virtual TypeId GetInstanceTypeId (void) const
template<typename T >
Ptr< T > GetObject (void) const
template<typename T >
Ptr< T > GetObject (TypeId tid) const
void Dispose (void)
void AggregateObject (Ptr< Object > other)
AggregateIterator GetAggregateIterator (void) const
void Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
uint32_t GetReferenceCount (void) const
- Public Member Functions inherited from ns3::ObjectBase
void SetAttribute (std::string name, const AttributeValue &value)
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
void GetAttribute (std::string name, AttributeValue &value) const
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
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 ()
 This method returns the TypeId associated to ns3::dot11s::HwmpProtocol.

Friends

class HwmpProtocolMac

Additional Inherited Members

- Public Types inherited from ns3::MeshL2RoutingProtocol
typedef Callback< void, bool,
Ptr< Packet >, Mac48Address,
Mac48Address, uint16_t,
uint32_t > 
RouteReplyCallback
- Protected Attributes inherited from ns3::MeshL2RoutingProtocol
Ptr< MeshPointDevicem_mp
 Host mesh point.

Detailed Description

Hybrid wireless mesh protocol – a routing protocol of IEEE 802.11s draft.


Member Function Documentation

void ns3::dot11s::HwmpProtocol::DoDispose ( void  )
virtual

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.

References ns3::EventId::Cancel(), ns3::MeshL2RoutingProtocol::m_mp, and NS_LOG_FUNCTION_NOARGS.

TypeId ns3::dot11s::HwmpProtocol::GetTypeId ( void  )
static

This method returns the TypeId associated to ns3::dot11s::HwmpProtocol.

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

  • /NodeList/[i]/DeviceList/[i]/$ns3::MeshPointDevice/RoutingProtocol/$ns3::dot11s::HwmpProtocol

Attributes defined for this type:

  • RandomStart: Random delay at first proactive PREQ
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +100000000.0ns
    • Flags: construct write read
  • MaxQueueSize: Maximum number of packets we can store when resolving route
  • Dot11MeshHWMPmaxPREQretries: Maximum number of retries before we suppose the destination to be unreachable
  • Dot11MeshHWMPnetDiameterTraversalTime: Time we suppose the packet to go from one edge of the network to another
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +102400000.0ns
    • Flags: construct write read
  • Dot11MeshHWMPpreqMinInterval: Minimal interval between to successive PREQs
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +102400000.0ns
    • Flags: construct write read
  • Dot11MeshHWMPperrMinInterval: Minimal interval between to successive PREQs
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +102400000.0ns
    • Flags: construct write read
  • Dot11MeshHWMPactiveRootTimeout: Lifetime of poractive routing information
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +5120000000.0ns
    • Flags: construct write read
  • Dot11MeshHWMPactivePathTimeout: Lifetime of reactive routing information
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +5120000000.0ns
    • Flags: construct write read
  • Dot11MeshHWMPpathToRootInterval: Interval between two successive proactive PREQs
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +2048000000.0ns
    • Flags: construct write read
  • Dot11MeshHWMPrannInterval: Lifetime of poractive routing information
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +5120000000.0ns
    • Flags: construct write read
  • MaxTtl: Initial value of Time To Live field
  • UnicastPerrThreshold: Maximum number of PERR receivers, when we send a PERR as a chain of unicasts
  • UnicastPreqThreshold: Maximum number of PREQ receivers, when we send a PREQ as a chain of unicasts
  • UnicastDataThreshold: Maximum number ofbroadcast receivers, when we send a broadcast as a chain of unicasts
  • DoFlag: Destination only HWMP flag
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: construct write read
  • RfFlag: Reply and forward flag
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: construct write read

TraceSources defined for this type:

  • RouteDiscoveryTime: The time of route discovery procedure

Reimplemented from ns3::MeshL2RoutingProtocol.

References ns3::MakeTraceSourceAccessor(), ns3::MicroSeconds(), ns3::Seconds(), and ns3::TypeId::SetParent().

bool ns3::dot11s::HwmpProtocol::Install ( Ptr< MeshPointDevice mp)
void ns3::dot11s::HwmpProtocol::SetNeighboursCallback ( Callback< std::vector< Mac48Address >, uint32_t >  cb)

This callback is used to obtain active neighbours on a given interface.

Parameters:
cbis a callback, which returns a list of addresses on given interface (uint32_t)

Referenced by ns3::Dot11sStack::InstallStack().


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