ns3::dot11s::HwmpTag Class Reference

Hwmp tag implements interaction between HWMP protocol and MeshWifiMac. More...

#include <hwmp-tag.h>

Inheritance diagram for ns3::dot11s::HwmpTag:

Collaboration diagram for ns3::dot11s::HwmpTag:

Public Member Functions
	HwmpTag ()
	~HwmpTag ()
void	DecrementTtl ()
virtual void	Deserialize (TagBuffer i)
Mac48Address	GetAddress ()
virtual TypeId	GetInstanceTypeId () const
uint32_t	GetMetric ()
uint32_t	GetSeqno ()
virtual uint32_t	GetSerializedSize () const
uint8_t	GetTtl ()
virtual void	Print (std::ostream &os) const
virtual void	Serialize (TagBuffer i) const
void	SetAddress (Mac48Address retransmitter)
void	SetMetric (uint32_t metric)
void	SetSeqno (uint32_t seqno)
void	SetTtl (uint8_t ttl)

Static Public Member Functions
static TypeId	GetTypeId ()
	This method returns the TypeId associated to ns3::dot11s::HwmpTag.

Private Attributes
Mac48Address	m_address
uint32_t	m_metric
uint32_t	m_seqno
uint8_t	m_ttl

Additional Inherited Members
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
virtual void	NotifyConstructionCompleted (void)

Detailed Description

Hwmp tag implements interaction between HWMP protocol and MeshWifiMac.

Hwmp tag keeps the following:

1. When packet is passed from Hwmp to 11sMAC:
   • retransmitter address,
   • TTL value,
2. When packet is passed to Hwmp from 11sMAC:
   • lasthop address,
   • TTL value,
   • metric value (metric of link is recalculated at each packet, but routing table stores metric obtained during path discovery procedure)

Definition at line 48 of file hwmp-tag.h.

Constructor & Destructor Documentation

ns3::dot11s::HwmpTag::HwmpTag

(

)

Definition at line 28 of file hwmp-tag.cc.

ns3::dot11s::HwmpTag::~HwmpTag

(

)

Definition at line 33 of file hwmp-tag.cc.

Member Function Documentation

void ns3::dot11s::HwmpTag::DecrementTtl

(

)

Definition at line 146 of file hwmp-tag.cc.

References m_ttl.

Referenced by ns3::dot11s::HwmpProtocol::RequestRoute().

Here is the caller graph for this function:

void ns3::dot11s::HwmpTag::Deserialize ( TagBuffer  i )

virtual

Parameters

i	the buffer to read data from.

Read the content of the tag from the provided tag buffer. DO NOT attempt to read more bytes than you wrote with Tag::Serialize.

Implements ns3::Tag.

Definition at line 123 of file hwmp-tag.cc.

References ns3::Mac48Address::CopyFrom(), m_address, m_metric, m_seqno, m_ttl, ns3::TagBuffer::ReadU32(), and ns3::TagBuffer::ReadU8().

Here is the call graph for this function:

Mac48Address ns3::dot11s::HwmpTag::GetAddress

(

void

)

Definition at line 44 of file hwmp-tag.cc.

References m_address.

Referenced by ns3::dot11s::HwmpProtocolMac::UpdateOutcomingFrame().

Here is the caller graph for this function:

TypeId ns3::dot11s::HwmpTag::GetInstanceTypeId ( ) const

virtual

Returns

the TypeId associated to the most-derived type of this instance.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Implements ns3::ObjectBase.

Definition at line 93 of file hwmp-tag.cc.

References GetTypeId().

Here is the call graph for this function:

uint32_t ns3::dot11s::HwmpTag::GetMetric

(

void

)

Definition at line 68 of file hwmp-tag.cc.

References m_metric.

uint32_t ns3::dot11s::HwmpTag::GetSeqno

(

)

Definition at line 80 of file hwmp-tag.cc.

References m_seqno.

Referenced by ns3::dot11s::HwmpProtocolMac::UpdateOutcomingFrame().

Here is the caller graph for this function:

uint32_t ns3::dot11s::HwmpTag::GetSerializedSize ( ) const

virtual

Returns

the number of bytes required to serialize the data of the tag.

This method is typically invoked by Packet::AddPacketTag or Packet::AddByteTag just prior to calling Tag::Serialize.

Implements ns3::Tag.

Definition at line 99 of file hwmp-tag.cc.

uint8_t ns3::dot11s::HwmpTag::GetTtl

(

void

)

Definition at line 56 of file hwmp-tag.cc.

References m_ttl.

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

Here is the caller graph for this function:

TypeId ns3::dot11s::HwmpTag::GetTypeId ( void  )

static

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

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

Reimplemented from ns3::Tag.

Definition at line 86 of file hwmp-tag.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::dot11s::HwmpTag::Print ( std::ostream &  os ) const

virtual

Parameters

os	the stream to print to

This method is typically invoked from the Packet::PrintByteTags or Packet::PrintPacketTags methods.

Implements ns3::Tag.

Definition at line 138 of file hwmp-tag.cc.

References m_address, m_metric, m_seqno, and m_ttl.

void ns3::dot11s::HwmpTag::Serialize ( TagBuffer  i ) const

virtual

Parameters

i	the buffer to write data into.

Write the content of the tag in the provided tag buffer. DO NOT attempt to write more bytes than you requested with Tag::GetSerializedSize.

Implements ns3::Tag.

Definition at line 108 of file hwmp-tag.cc.

References ns3::Mac48Address::CopyTo(), m_address, m_metric, m_seqno, m_ttl, ns3::TagBuffer::WriteU32(), and ns3::TagBuffer::WriteU8().

Here is the call graph for this function:

void ns3::dot11s::HwmpTag::SetAddress

(

Mac48Address

retransmitter

)

Definition at line 38 of file hwmp-tag.cc.

References m_address.

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

Here is the caller graph for this function:

void ns3::dot11s::HwmpTag::SetMetric

(

uint32_t

metric

)

Definition at line 62 of file hwmp-tag.cc.

References m_metric.

void ns3::dot11s::HwmpTag::SetSeqno

(

uint32_t

seqno

)

Definition at line 74 of file hwmp-tag.cc.

References m_seqno.

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

Here is the caller graph for this function:

void ns3::dot11s::HwmpTag::SetTtl

(

uint8_t

ttl

)

Definition at line 50 of file hwmp-tag.cc.

References m_ttl.

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

Here is the caller graph for this function:

Member Data Documentation

Mac48Address ns3::dot11s::HwmpTag::m_address

private

Definition at line 70 of file hwmp-tag.h.

Referenced by Deserialize(), GetAddress(), Print(), Serialize(), and SetAddress().

uint32_t ns3::dot11s::HwmpTag::m_metric

private

Definition at line 72 of file hwmp-tag.h.

Referenced by Deserialize(), GetMetric(), Print(), Serialize(), and SetMetric().

uint32_t ns3::dot11s::HwmpTag::m_seqno

private

Definition at line 73 of file hwmp-tag.h.

Referenced by Deserialize(), GetSeqno(), Print(), Serialize(), and SetSeqno().

uint8_t ns3::dot11s::HwmpTag::m_ttl

private

Definition at line 71 of file hwmp-tag.h.

Referenced by DecrementTtl(), Deserialize(), GetTtl(), Print(), Serialize(), and SetTtl().

---

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

• src/mesh/model/dot11s/hwmp-tag.h
• doc/introspected-doxygen.h
• src/mesh/model/dot11s/hwmp-tag.cc