Root announcement (RANN) element. More...
#include "ie-dot11s-rann.h"
Public Member Functions | |
IeRann () | |
~IeRann () override | |
void | DecrementTtl () |
Decrement TTL function. | |
uint16_t | DeserializeInformationField (Buffer::Iterator start, uint16_t length) override |
Deserialize information (i.e., the body of the IE, not including the Element ID and length octets) | |
WifiInformationElementId | ElementId () const override |
Get the wifi information element ID. | |
uint32_t | GetDestSeqNumber () const |
Get destination sequence number value. | |
uint8_t | GetFlags () const |
Get flags value. | |
uint8_t | GetHopcount () const |
Get hop count value. | |
uint16_t | GetInformationFieldSize () const override |
Length of serialized information (i.e., the length of the body of the IE, not including the Element ID and length octets. | |
uint32_t | GetMetric () const |
Get metric value. | |
Mac48Address | GetOriginatorAddress () |
Get originator address value. | |
uint8_t | GetTtl () const |
Get TTL value. | |
void | IncrementMetric (uint32_t metric) |
Increment metric. | |
void | Print (std::ostream &os) const override |
Generate human-readable form of IE. | |
void | SerializeInformationField (Buffer::Iterator i) const override |
Serialize information (i.e., the body of the IE, not including the Element ID and length octets) | |
void | SetDestSeqNumber (uint32_t dest_seq_number) |
Set destination sequence number value. | |
void | SetFlags (uint8_t flags) |
Set flags field. | |
void | SetHopcount (uint8_t hopcount) |
Set hop count value to number of hops from the originating root mesh STA to the mesh STA transmitting this element. | |
void | SetMetric (uint32_t metric) |
Set metric value to cumulative metric from originating root mesh STA to the mesh STA transmitting the announcement. | |
void | SetOriginatorAddress (Mac48Address originator_address) |
Set originator address value. | |
void | SetTTL (uint8_t ttl) |
Set TTL value to the remaining number of hops allowed. | |
Public Member Functions inherited from ns3::WifiInformationElement | |
virtual | ~WifiInformationElement () |
Buffer::Iterator | Deserialize (Buffer::Iterator i) |
Deserialize entire IE (which may possibly be fragmented into multiple elements), which must be present. | |
Buffer::Iterator | DeserializeIfPresent (Buffer::Iterator i) |
Deserialize entire IE (which may possibly be fragmented into multiple elements) if it is present. | |
virtual WifiInformationElementId | ElementIdExt () const |
Get the wifi information element ID extension. | |
uint16_t | GetSerializedSize () const |
Get the size of the serialized IE including Element ID and length fields (for every element this IE is possibly fragmented into). | |
virtual bool | operator== (const WifiInformationElement &a) const |
Compare two IEs for equality by ID & Length, and then through memcmp of serialised version. | |
Buffer::Iterator | Serialize (Buffer::Iterator i) const |
Serialize entire IE including Element ID and length fields. | |
Public Member Functions inherited from ns3::SimpleRefCount< WifiInformationElement > | |
SimpleRefCount () | |
Default constructor. | |
SimpleRefCount (const SimpleRefCount &o) | |
Copy constructor. | |
uint32_t | GetReferenceCount () const |
Get the reference count of the object. | |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
Assignment operator. | |
void | Ref () const |
Increment the reference count. | |
void | Unref () const |
Decrement the reference count. | |
Private Attributes | |
uint32_t | m_destSeqNumber |
destination sequence number | |
uint8_t | m_flags |
flags | |
uint8_t | m_hopcount |
hop count | |
uint32_t | m_metric |
metric | |
Mac48Address | m_originatorAddress |
originator address | |
uint8_t | m_ttl |
TTL. | |
Friends | |
bool | operator== (const IeRann &a, const IeRann &b) |
equality operator | |
Root announcement (RANN) element.
Definition at line 23 of file ie-dot11s-rann.h.
ns3::dot11s::IeRann::IeRann | ( | ) |
Definition at line 24 of file ie-dot11s-rann.cc.
|
override |
Definition at line 20 of file ie-dot11s-rann.cc.
void ns3::dot11s::IeRann::DecrementTtl | ( | ) |
Decrement TTL function.
Definition at line 107 of file ie-dot11s-rann.cc.
References m_hopcount, and m_ttl.
|
overridevirtual |
Deserialize information (i.e., the body of the IE, not including the Element ID and length octets)
start | an iterator which points to where the information should be written. |
length | the expected number of bytes to read |
Implements ns3::WifiInformationElement.
Definition at line 137 of file ie-dot11s-rann.cc.
References ns3::Buffer::Iterator::GetDistanceFrom(), m_destSeqNumber, m_flags, m_hopcount, m_metric, m_originatorAddress, m_ttl, ns3::ReadFrom(), ns3::Buffer::Iterator::ReadLsbtohU32(), and ns3::Buffer::Iterator::ReadU8().
|
overridevirtual |
Get the wifi information element ID.
Implements ns3::WifiInformationElement.
Definition at line 35 of file ie-dot11s-rann.cc.
References IE_RANN.
uint32_t ns3::dot11s::IeRann::GetDestSeqNumber | ( | ) | const |
Get destination sequence number value.
Definition at line 95 of file ie-dot11s-rann.cc.
References m_destSeqNumber.
uint8_t ns3::dot11s::IeRann::GetFlags | ( | ) | const |
Get flags value.
Definition at line 77 of file ie-dot11s-rann.cc.
References m_flags.
uint8_t ns3::dot11s::IeRann::GetHopcount | ( | ) | const |
Get hop count value.
Definition at line 83 of file ie-dot11s-rann.cc.
References m_hopcount.
|
overridevirtual |
Length of serialized information (i.e., the length of the body of the IE, not including the Element ID and length octets.
This is the value that will appear in the second octet of the entire IE - the length field - if the IE is not fragmented)
Implements ns3::WifiInformationElement.
Definition at line 150 of file ie-dot11s-rann.cc.
uint32_t ns3::dot11s::IeRann::GetMetric | ( | ) | const |
Get metric value.
Definition at line 101 of file ie-dot11s-rann.cc.
References m_metric.
Mac48Address ns3::dot11s::IeRann::GetOriginatorAddress | ( | ) |
Get originator address value.
Definition at line 120 of file ie-dot11s-rann.cc.
References m_originatorAddress.
uint8_t ns3::dot11s::IeRann::GetTtl | ( | ) | const |
void ns3::dot11s::IeRann::IncrementMetric | ( | uint32_t | metric | ) |
Increment metric.
metric | the value to increment |
Definition at line 114 of file ie-dot11s-rann.cc.
References m_metric.
|
overridevirtual |
Generate human-readable form of IE.
os | output stream |
Reimplemented from ns3::WifiInformationElement.
Definition at line 162 of file ie-dot11s-rann.cc.
References m_destSeqNumber, m_flags, m_hopcount, m_metric, m_originatorAddress, and m_ttl.
Referenced by ns3::dot11s::operator<<().
|
overridevirtual |
Serialize information (i.e., the body of the IE, not including the Element ID and length octets)
start | an iterator which points to where the information should be written. |
Implements ns3::WifiInformationElement.
Definition at line 126 of file ie-dot11s-rann.cc.
References m_destSeqNumber, m_flags, m_hopcount, m_metric, m_originatorAddress, m_ttl, ns3::Buffer::Iterator::WriteHtolsbU32(), ns3::WriteTo(), and ns3::Buffer::Iterator::WriteU8().
void ns3::dot11s::IeRann::SetDestSeqNumber | ( | uint32_t | dest_seq_number | ) |
Set destination sequence number value.
dest_seq_number | the destination sequence number |
Definition at line 59 of file ie-dot11s-rann.cc.
References m_destSeqNumber.
void ns3::dot11s::IeRann::SetFlags | ( | uint8_t | flags | ) |
Set flags field.
flags | the flags value to set |
Definition at line 41 of file ie-dot11s-rann.cc.
References m_flags.
void ns3::dot11s::IeRann::SetHopcount | ( | uint8_t | hopcount | ) |
Set hop count value to number of hops from the originating root mesh STA to the mesh STA transmitting this element.
hopcount | the hop count |
Definition at line 47 of file ie-dot11s-rann.cc.
References m_hopcount.
void ns3::dot11s::IeRann::SetMetric | ( | uint32_t | metric | ) |
Set metric value to cumulative metric from originating root mesh STA to the mesh STA transmitting the announcement.
metric | the metric to set |
Definition at line 65 of file ie-dot11s-rann.cc.
References m_metric.
void ns3::dot11s::IeRann::SetOriginatorAddress | ( | Mac48Address | originator_address | ) |
Set originator address value.
originator_address | the originator MAC address |
Definition at line 71 of file ie-dot11s-rann.cc.
References m_originatorAddress.
void ns3::dot11s::IeRann::SetTTL | ( | uint8_t | ttl | ) |
Set TTL value to the remaining number of hops allowed.
ttl | the TTL |
Definition at line 53 of file ie-dot11s-rann.cc.
References m_ttl.
equality operator
a | lhs |
b | rhs |
Definition at line 170 of file ie-dot11s-rann.cc.
|
private |
destination sequence number
Definition at line 110 of file ie-dot11s-rann.h.
Referenced by DeserializeInformationField(), GetDestSeqNumber(), Print(), SerializeInformationField(), and SetDestSeqNumber().
|
private |
flags
Definition at line 106 of file ie-dot11s-rann.h.
Referenced by DeserializeInformationField(), GetFlags(), Print(), SerializeInformationField(), and SetFlags().
|
private |
hop count
Definition at line 107 of file ie-dot11s-rann.h.
Referenced by DecrementTtl(), DeserializeInformationField(), GetHopcount(), Print(), SerializeInformationField(), and SetHopcount().
|
private |
metric
Definition at line 111 of file ie-dot11s-rann.h.
Referenced by DeserializeInformationField(), GetMetric(), IncrementMetric(), Print(), SerializeInformationField(), and SetMetric().
|
private |
originator address
Definition at line 109 of file ie-dot11s-rann.h.
Referenced by DeserializeInformationField(), GetOriginatorAddress(), Print(), SerializeInformationField(), and SetOriginatorAddress().
|
private |
TTL.
Definition at line 108 of file ie-dot11s-rann.h.
Referenced by DecrementTtl(), DeserializeInformationField(), GetTtl(), Print(), SerializeInformationField(), and SetTTL().