A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Private Attributes | Friends | List of all members
ns3::dot11s::IePrep Class Reference
IEEE 802.11s draft

See 7.3.2.97 of 802.11s draft 2.07. More...

#include <ie-dot11s-prep.h>

+ Inheritance diagram for ns3::dot11s::IePrep:
+ Collaboration diagram for ns3::dot11s::IePrep:

Public Member Functions

 IePrep ()
 
 ~IePrep ()
 
void DecrementTtl ()
 
Mac48Address GetDestinationAddress () const
 
uint32_t GetDestinationSeqNumber () const
 
uint8_t GetFlags () const
 
uint8_t GetHopcount () const
 
uint32_t GetLifetime () const
 
uint32_t GetMetric () const
 
Mac48Address GetOriginatorAddress () const
 
uint32_t GetOriginatorSeqNumber () const
 
uint32_t GetTtl () const
 
void IncrementMetric (uint32_t metric)
 
void SetDestinationAddress (Mac48Address dest_address)
 
void SetDestinationSeqNumber (uint32_t dest_seq_number)
 
void SetFlags (uint8_t flags)
 
void SetHopcount (uint8_t hopcount)
 
void SetLifetime (uint32_t lifetime)
 
void SetMetric (uint32_t metric)
 
void SetOriginatorAddress (Mac48Address originator_address)
 
void SetOriginatorSeqNumber (uint32_t originator_seq_number)
 
void SetTtl (uint8_t ttl)
 
Inherited from WifiInformationElement
virtual WifiInformationElementId ElementId () const
 Own unique Element ID. More...
 
virtual void SerializeInformationField (Buffer::Iterator i) const
 Serialize information (i.e., the body of the IE, not including the Element ID and length octets) More...
 
virtual uint8_t DeserializeInformationField (Buffer::Iterator start, uint8_t length)
 Deserialize information (i.e., the body of the IE, not including the Element ID and length octets) More...
 
virtual uint8_t GetInformationFieldSize () const
 Length of serialized information (i.e., the length of the body of the IE, not including the Element ID and length octets. More...
 
virtual void Print (std::ostream &os) const
 In addition, a subclass may optionally override the following... More...
 
- Public Member Functions inherited from ns3::WifiInformationElement
virtual ~WifiInformationElement ()
 
Buffer::Iterator Deserialize (Buffer::Iterator i)
 Deserialize entire IE, which must be present. More...
 
Buffer::Iterator DeserializeIfPresent (Buffer::Iterator i)
 Deserialize entire IE if it is present. More...
 
uint16_t GetSerializedSize () const
 Get the size of the serialized IE including Element ID and length fields. More...
 
Buffer::Iterator Serialize (Buffer::Iterator i) const
 Serialize entire IE including Element ID and length fields. More...
 
virtual bool operator< (WifiInformationElement const &a) const
 Compare information elements using Element ID. More...
 
virtual bool operator== (WifiInformationElement const &a) const
 Compare two IEs for equality by ID & Length, and then through memcmp of serialised version. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< WifiInformationElement >
 SimpleRefCount ()
 Constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCount & operator= (const SimpleRefCount &o)
 Assignment. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 

Private Attributes

Mac48Address m_destinationAddress
 
uint32_t m_destSeqNumber
 
uint8_t m_flags
 
uint8_t m_hopcount
 
uint32_t m_lifetime
 
uint32_t m_metric
 
Mac48Address m_originatorAddress
 
uint32_t m_originatorSeqNumber
 
uint8_t m_ttl
 

Friends

bool operator== (const IePrep &a, const IePrep &b)
 

Additional Inherited Members

- Static Public Member Functions inherited from ns3::SimpleRefCount< WifiInformationElement >
static void Cleanup (void)
 Noop. More...
 

Detailed Description

See 7.3.2.97 of 802.11s draft 2.07.

Definition at line 33 of file ie-dot11s-prep.h.

Constructor & Destructor Documentation

ns3::dot11s::IePrep::IePrep ( )

Definition at line 33 of file ie-dot11s-prep.cc.

ns3::dot11s::IePrep::~IePrep ( )

Definition at line 30 of file ie-dot11s-prep.cc.

Member Function Documentation

void ns3::dot11s::IePrep::DecrementTtl ( )

Definition at line 135 of file ie-dot11s-prep.cc.

References m_hopcount, and m_ttl.

uint8_t ns3::dot11s::IePrep::DeserializeInformationField ( Buffer::Iterator  start,
uint8_t  length 
)
virtual

Deserialize information (i.e., the body of the IE, not including the Element ID and length octets)

Parameters
startan iterator which points to where the information should be written.
length
Returns
the number of bytes read

Implements ns3::WifiInformationElement.

Definition at line 161 of file ie-dot11s-prep.cc.

References ns3::Buffer::Iterator::GetDistanceFrom(), m_destinationAddress, m_destSeqNumber, m_flags, m_hopcount, m_lifetime, m_metric, m_originatorAddress, m_originatorSeqNumber, m_ttl, ns3::ReadFrom(), ns3::Buffer::Iterator::ReadLsbtohU32(), ns3::Buffer::Iterator::ReadU8(), and visualizer.core::start().

+ Here is the call graph for this function:

WifiInformationElementId ns3::dot11s::IePrep::ElementId ( ) const
virtual

Own unique Element ID.

Implements ns3::WifiInformationElement.

Definition at line 40 of file ie-dot11s-prep.cc.

References IE11S_PREP.

Referenced by Print().

+ Here is the caller graph for this function:

Mac48Address ns3::dot11s::IePrep::GetDestinationAddress ( void  ) const

Definition at line 110 of file ie-dot11s-prep.cc.

References m_destinationAddress.

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

+ Here is the caller graph for this function:

uint32_t ns3::dot11s::IePrep::GetDestinationSeqNumber ( ) const

Definition at line 105 of file ie-dot11s-prep.cc.

References m_destSeqNumber.

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

+ Here is the caller graph for this function:

uint8_t ns3::dot11s::IePrep::GetFlags ( ) const

Definition at line 90 of file ie-dot11s-prep.cc.

References m_flags.

uint8_t ns3::dot11s::IePrep::GetHopcount ( ) const

Definition at line 95 of file ie-dot11s-prep.cc.

References m_hopcount.

uint8_t ns3::dot11s::IePrep::GetInformationFieldSize ( ) const
virtual

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)

Returns
the length of serialized information

Implements ns3::WifiInformationElement.

Definition at line 176 of file ie-dot11s-prep.cc.

uint32_t ns3::dot11s::IePrep::GetLifetime ( void  ) const

Definition at line 130 of file ie-dot11s-prep.cc.

References m_lifetime.

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

+ Here is the caller graph for this function:

uint32_t ns3::dot11s::IePrep::GetMetric ( void  ) const

Definition at line 115 of file ie-dot11s-prep.cc.

References m_metric.

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

+ Here is the caller graph for this function:

Mac48Address ns3::dot11s::IePrep::GetOriginatorAddress ( ) const

Definition at line 120 of file ie-dot11s-prep.cc.

References m_originatorAddress.

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

+ Here is the caller graph for this function:

uint32_t ns3::dot11s::IePrep::GetOriginatorSeqNumber ( ) const

Definition at line 125 of file ie-dot11s-prep.cc.

References m_originatorSeqNumber.

uint32_t ns3::dot11s::IePrep::GetTtl ( void  ) const

Definition at line 100 of file ie-dot11s-prep.cc.

References m_ttl.

void ns3::dot11s::IePrep::IncrementMetric ( uint32_t  metric)

Definition at line 142 of file ie-dot11s-prep.cc.

References m_metric.

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

+ Here is the caller graph for this function:

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

In addition, a subclass may optionally override the following...

Generate human-readable form of IE

Parameters
osoutput stream

Reimplemented from ns3::WifiInformationElement.

Definition at line 190 of file ie-dot11s-prep.cc.

References ElementId(), m_destinationAddress, m_destSeqNumber, m_flags, m_hopcount, m_lifetime, m_metric, m_originatorAddress, m_originatorSeqNumber, and m_ttl.

Referenced by ns3::dot11s::operator<<().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::dot11s::IePrep::SerializeInformationField ( Buffer::Iterator  start) const
virtual

Serialize information (i.e., the body of the IE, not including the Element ID and length octets)

Parameters
startan iterator which points to where the information should be written.

Implements ns3::WifiInformationElement.

Definition at line 148 of file ie-dot11s-prep.cc.

References m_destinationAddress, m_destSeqNumber, m_flags, m_hopcount, m_lifetime, m_metric, m_originatorAddress, m_originatorSeqNumber, m_ttl, ns3::Buffer::Iterator::WriteHtolsbU32(), ns3::WriteTo(), and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

void ns3::dot11s::IePrep::SetDestinationAddress ( Mac48Address  dest_address)

Definition at line 65 of file ie-dot11s-prep.cc.

References m_destinationAddress.

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

+ Here is the caller graph for this function:

void ns3::dot11s::IePrep::SetDestinationSeqNumber ( uint32_t  dest_seq_number)

Definition at line 60 of file ie-dot11s-prep.cc.

References m_destSeqNumber.

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

+ Here is the caller graph for this function:

void ns3::dot11s::IePrep::SetFlags ( uint8_t  flags)

Definition at line 45 of file ie-dot11s-prep.cc.

References m_flags.

void ns3::dot11s::IePrep::SetHopcount ( uint8_t  hopcount)

Definition at line 50 of file ie-dot11s-prep.cc.

References m_hopcount.

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

+ Here is the caller graph for this function:

void ns3::dot11s::IePrep::SetLifetime ( uint32_t  lifetime)

Definition at line 85 of file ie-dot11s-prep.cc.

References m_lifetime.

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

+ Here is the caller graph for this function:

void ns3::dot11s::IePrep::SetMetric ( uint32_t  metric)

Definition at line 70 of file ie-dot11s-prep.cc.

References m_metric.

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

+ Here is the caller graph for this function:

void ns3::dot11s::IePrep::SetOriginatorAddress ( Mac48Address  originator_address)

Definition at line 75 of file ie-dot11s-prep.cc.

References m_originatorAddress.

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

+ Here is the caller graph for this function:

void ns3::dot11s::IePrep::SetOriginatorSeqNumber ( uint32_t  originator_seq_number)

Definition at line 80 of file ie-dot11s-prep.cc.

References m_originatorSeqNumber.

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

+ Here is the caller graph for this function:

void ns3::dot11s::IePrep::SetTtl ( uint8_t  ttl)

Definition at line 55 of file ie-dot11s-prep.cc.

References m_ttl.

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

+ Here is the caller graph for this function:

Friends And Related Function Documentation

bool operator== ( const IePrep &  a,
const IePrep &  b 
)
friend

Definition at line 200 of file ie-dot11s-prep.cc.

Member Data Documentation

Mac48Address ns3::dot11s::IePrep::m_destinationAddress
private

Definition at line 74 of file ie-dot11s-prep.h.

Referenced by DeserializeInformationField(), GetDestinationAddress(), ns3::dot11s::operator==(), Print(), SerializeInformationField(), and SetDestinationAddress().

uint32_t ns3::dot11s::IePrep::m_destSeqNumber
private

Definition at line 75 of file ie-dot11s-prep.h.

Referenced by DeserializeInformationField(), GetDestinationSeqNumber(), ns3::dot11s::operator==(), Print(), SerializeInformationField(), and SetDestinationSeqNumber().

uint8_t ns3::dot11s::IePrep::m_flags
private

Definition at line 71 of file ie-dot11s-prep.h.

Referenced by DeserializeInformationField(), GetFlags(), ns3::dot11s::operator==(), Print(), SerializeInformationField(), and SetFlags().

uint8_t ns3::dot11s::IePrep::m_hopcount
private

Definition at line 72 of file ie-dot11s-prep.h.

Referenced by DecrementTtl(), DeserializeInformationField(), GetHopcount(), ns3::dot11s::operator==(), Print(), SerializeInformationField(), and SetHopcount().

uint32_t ns3::dot11s::IePrep::m_lifetime
private

Definition at line 76 of file ie-dot11s-prep.h.

Referenced by DeserializeInformationField(), GetLifetime(), ns3::dot11s::operator==(), Print(), SerializeInformationField(), and SetLifetime().

uint32_t ns3::dot11s::IePrep::m_metric
private

Definition at line 77 of file ie-dot11s-prep.h.

Referenced by DeserializeInformationField(), GetMetric(), IncrementMetric(), ns3::dot11s::operator==(), Print(), SerializeInformationField(), and SetMetric().

Mac48Address ns3::dot11s::IePrep::m_originatorAddress
private

Definition at line 78 of file ie-dot11s-prep.h.

Referenced by DeserializeInformationField(), GetOriginatorAddress(), ns3::dot11s::operator==(), Print(), SerializeInformationField(), and SetOriginatorAddress().

uint32_t ns3::dot11s::IePrep::m_originatorSeqNumber
private

Definition at line 79 of file ie-dot11s-prep.h.

Referenced by DeserializeInformationField(), GetOriginatorSeqNumber(), ns3::dot11s::operator==(), Print(), SerializeInformationField(), and SetOriginatorSeqNumber().

uint8_t ns3::dot11s::IePrep::m_ttl
private

Definition at line 73 of file ie-dot11s-prep.h.

Referenced by DecrementTtl(), DeserializeInformationField(), GetTtl(), ns3::dot11s::operator==(), Print(), SerializeInformationField(), and SetTtl().

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