A Discrete-Event Network Simulator
API
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 ()
 Decrement TTL. More...
 
virtual void Deserialize (TagBuffer i)
 
Mac48Address GetAddress ()
 Get address from tag. More...
 
virtual TypeId GetInstanceTypeId () const
 Get the most derived TypeId for this Object. More...
 
uint32_t GetMetric ()
 Get the metric value. More...
 
uint32_t GetSeqno ()
 Get the sequence number. More...
 
virtual uint32_t GetSerializedSize () const
 
uint8_t GetTtl ()
 Get the TTL value. More...
 
virtual void Print (std::ostream &os) const
 
virtual void Serialize (TagBuffer i) const
 
void SetAddress (Mac48Address retransmitter)
 Set address. More...
 
void SetMetric (uint32_t metric)
 Set the metric value. More...
 
void SetSeqno (uint32_t seqno)
 Set sequence number. More...
 
void SetTtl (uint8_t ttl)
 Set the TTL value. 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::Tag
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

Mac48Address m_address
 address More...
 
uint32_t m_metric
 metric More...
 
uint32_t m_seqno
 sequence no More...
 
uint8_t m_ttl
 TTL. More...
 

Additional Inherited Members

- 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

Hwmp tag implements interaction between HWMP protocol and MeshWifiMac.

Introspection did not find any typical Config paths.

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)


No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 24 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

ns3::dot11s::HwmpTag::HwmpTag ( )

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

ns3::dot11s::HwmpTag::~HwmpTag ( )

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

Member Function Documentation

void ns3::dot11s::HwmpTag::DecrementTtl ( )

Decrement TTL.

Definition at line 155 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
ithe 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 132 of file hwmp-tag.cc.

References first::address, 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  )

Get address from tag.

Returns
the MAC address

Definition at line 45 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

Get the most derived TypeId for this Object.

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

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

Implements ns3::ObjectBase.

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

References GetTypeId().

+ Here is the call graph for this function:

uint32_t ns3::dot11s::HwmpTag::GetMetric ( void  )

Get the metric value.

Returns
the metric

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

References m_metric.

uint32_t ns3::dot11s::HwmpTag::GetSeqno ( )

Get the sequence number.

Returns
the sequence number

Definition at line 81 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 108 of file hwmp-tag.cc.

uint8_t ns3::dot11s::HwmpTag::GetTtl ( void  )

Get the TTL value.

Returns
the TTL

Definition at line 57 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

Get the type ID.

Returns
the object TypeId

Definition at line 91 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
osthe stream to print to

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

Implements ns3::Tag.

Definition at line 147 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
ithe 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 117 of file hwmp-tag.cc.

References first::address, 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)

Set address.

Parameters
retransmitterthe MAC address of the retransmitter

Definition at line 39 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)

Set the metric value.

Parameters
metricthe metric

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

References m_metric.

void ns3::dot11s::HwmpTag::SetSeqno ( uint32_t  seqno)

Set sequence number.

Parameters
seqnothe sequence number

Definition at line 75 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)

Set the TTL value.

Parameters
ttl

Definition at line 51 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

address

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

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

uint32_t ns3::dot11s::HwmpTag::m_metric
private

metric

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

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

uint32_t ns3::dot11s::HwmpTag::m_seqno
private

sequence no

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

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

uint8_t ns3::dot11s::HwmpTag::m_ttl
private

TTL.

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