ns3::dot11s::HwmpProtocol Class Reference
[IEEE 802.11s draft]

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

#include <hwmp-protocol.h>

Inheritance diagram for ns3::dot11s::HwmpProtocol:

[legend]

Collaboration diagram for ns3::dot11s::HwmpProtocol:

[legend]

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 ()
Static Public Member Functions
static TypeId	GetTypeId ()
	This method returns the TypeId associated to ns3::dot11s::HwmpProtocol.
Friends
class	HwmpProtocolMac

---

Detailed Description

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

---

Member Function Documentation

void ns3::dot11s::HwmpProtocol::DoDispose

(

)

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

static 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::AlohaNoackNetDevice/Phy/$ns3::MeshL2RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::AlohaNoackNetDevice/Phy/$ns3::MeshPointDevice/RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::AlohaNoackNetDevice/Phy/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::MeshL2RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::MeshPointDevice/RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/LinkManager/$ns3::MeshL2RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/LinkManager/$ns3::MeshPointDevice/RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/LinkManager/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/SSManager/$ns3::MeshL2RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/SSManager/$ns3::MeshPointDevice/RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/SSManager/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::MeshL2RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::MeshPointDevice/RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::MeshPointDevice/RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::NonCommunicatingNetDevice/Phy/$ns3::MeshL2RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::NonCommunicatingNetDevice/Phy/$ns3::MeshPointDevice/RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::NonCommunicatingNetDevice/Phy/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/Classifier/$ns3::MeshL2RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/Classifier/$ns3::MeshPointDevice/RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/Classifier/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::MeshL2RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::MeshPointDevice/RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::MeshL2RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::MeshPointDevice/RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/NoiseModel/$ns3::MeshL2RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/NoiseModel/$ns3::MeshPointDevice/RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/NoiseModel/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/PropagationModel/$ns3::MeshL2RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/PropagationModel/$ns3::MeshPointDevice/RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/PropagationModel/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Mac/$ns3::MeshL2RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Mac/$ns3::MeshPointDevice/RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Mac/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Phy/$ns3::MeshL2RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Phy/$ns3::MeshPointDevice/RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Phy/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Transducer/$ns3::MeshL2RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Transducer/$ns3::MeshPointDevice/RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Transducer/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::MeshL2RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::MeshPointDevice/RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/LinkManager/$ns3::MeshL2RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/LinkManager/$ns3::MeshPointDevice/RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/LinkManager/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/SSManager/$ns3::MeshL2RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/SSManager/$ns3::MeshPointDevice/RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/SSManager/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::MeshL2RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::MeshPointDevice/RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/Classifier/$ns3::MeshL2RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/Classifier/$ns3::MeshPointDevice/RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/Classifier/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::MeshL2RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::MeshPointDevice/RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::MeshL2RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::MeshPointDevice/RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BandwidthManager/$ns3::MeshL2RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BandwidthManager/$ns3::MeshPointDevice/RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BandwidthManager/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BurstProfileManager/$ns3::MeshL2RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BurstProfileManager/$ns3::MeshPointDevice/RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BurstProfileManager/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/NoiseModel/$ns3::MeshL2RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/NoiseModel/$ns3::MeshPointDevice/RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/NoiseModel/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/PropagationModel/$ns3::MeshL2RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/PropagationModel/$ns3::MeshPointDevice/RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/PropagationModel/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/ConnectionManager/$ns3::MeshL2RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/ConnectionManager/$ns3::MeshPointDevice/RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/ConnectionManager/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/NoiseModel/$ns3::MeshL2RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/NoiseModel/$ns3::MeshPointDevice/RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/NoiseModel/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/PropagationModel/$ns3::MeshL2RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/PropagationModel/$ns3::MeshPointDevice/RoutingProtocol/$ns3::dot11s::HwmpProtocol
• /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/PropagationModel/$ns3::dot11s::HwmpProtocol

Attributes defined for this type:

• RandomStart: Random delay at first proactive PREQ
  • Set with class: TimeValue
  • Underlying type: Time
  • Initial value: 100000000ns
  • Flags: construct write read
• MaxQueueSize: Maximum number of packets we can store when resolving route
  • Set with class: ns3::UintegerValue
  • Underlying type: uint16_t 1:65535
  • Initial value: 255
  • Flags: construct write read
• Dot11MeshHWMPmaxPREQretries: Maximum number of retries before we suppose the destination to be unreachable
  • Set with class: ns3::UintegerValue
  • Underlying type: uint8_t 1:255
  • Initial value: 3
  • Flags: construct write read
• 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: 102400000ns
  • Flags: construct write read
• Dot11MeshHWMPpreqMinInterval: Minimal interval between to successive PREQs
  • Set with class: TimeValue
  • Underlying type: Time
  • Initial value: 102400000ns
  • Flags: construct write read
• Dot11MeshHWMPperrMinInterval: Minimal interval between to successive PREQs
  • Set with class: TimeValue
  • Underlying type: Time
  • Initial value: 102400000ns
  • Flags: construct write read
• Dot11MeshHWMPactiveRootTimeout: Lifetime of poractive routing information
  • Set with class: TimeValue
  • Underlying type: Time
  • Initial value: 5120000000ns
  • Flags: construct write read
• Dot11MeshHWMPactivePathTimeout: Lifetime of reactive routing information
  • Set with class: TimeValue
  • Underlying type: Time
  • Initial value: 5120000000ns
  • Flags: construct write read
• Dot11MeshHWMPpathToRootInterval: Interval between two successive proactive PREQs
  • Set with class: TimeValue
  • Underlying type: Time
  • Initial value: 2048000000ns
  • Flags: construct write read
• Dot11MeshHWMPrannInterval: Lifetime of poractive routing information
  • Set with class: TimeValue
  • Underlying type: Time
  • Initial value: 5120000000ns
  • Flags: construct write read
• MaxTtl: Initial value of Time To Live field
  • Set with class: ns3::UintegerValue
  • Underlying type: uint8_t 2:255
  • Initial value: 32
  • Flags: construct write read
• UnicastPerrThreshold: Maximum number of PERR receivers, when we send a PERR as a chain of unicasts
  • Set with class: ns3::UintegerValue
  • Underlying type: uint8_t 1:255
  • Initial value: 32
  • Flags: construct write read
• UnicastPreqThreshold: Maximum number of PREQ receivers, when we send a PREQ as a chain of unicasts
  • Set with class: ns3::UintegerValue
  • Underlying type: uint8_t 1:255
  • Initial value: 1
  • Flags: construct write read
• UnicastDataThreshold: Maximum number ofbroadcast receivers, when we send a broadcast as a chain of unicasts
  • Set with class: ns3::UintegerValue
  • Underlying type: uint8_t 1:255
  • Initial value: 1
  • Flags: construct write read
• 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.

bool ns3::dot11s::HwmpProtocol::Install

(

Ptr< MeshPointDevice >

)

Install HWMP on given mesh point.

Installing protocol cause installing its interface MAC plugins.

Also MP aggregates all installed protocols, HWMP protocol can be accessed via MeshPointDevice::GetObject<dot11s::HwmpProtocol>();

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:

cb

is a callback, which returns a list of addresses on given interface (uint32_t)

---

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

• src/devices/mesh/dot11s/hwmp-protocol.h
• doc/introspected-doxygen.h