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 () 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.

Mac48Address	GetDestinationAddress () const
	Get destination address function.

uint32_t	GetDestinationSeqNumber () const
	Get destination sequence number function.

uint8_t	GetFlags () const
	Get flags function.

uint8_t	GetHopcount () const
	Get hop count function.

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	GetLifetime () const
	Get lifetime function.

uint32_t	GetMetric () const
	Get metric function.

Mac48Address	GetOriginatorAddress () const
	Get originator address function.

uint32_t	GetOriginatorSeqNumber () const
	Get originator sequence number.

uint32_t	GetTtl () const
	Get TTL function.

void	IncrementMetric (uint32_t metric)
	Increment metric function.

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	SetDestinationAddress (Mac48Address dest_address)
	Set destination address function.

void	SetDestinationSeqNumber (uint32_t dest_seq_number)
	Set destination sequence number function.

void	SetFlags (uint8_t flags)
	Set flags function.

void	SetHopcount (uint8_t hopcount)
	Set hop count function.

void	SetLifetime (uint32_t lifetime)
	Set lifetime function.

void	SetMetric (uint32_t metric)
	Set metric function.

void	SetOriginatorAddress (Mac48Address originator_address)
	Set originator address function.

void	SetOriginatorSeqNumber (uint32_t originator_seq_number)
	Set originator sequence number function.

void	SetTtl (uint8_t ttl)
	Set TTL function.

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
Mac48Address	m_destinationAddress
	destination address

uint32_t	m_destSeqNumber
	destination sequence number

uint8_t	m_flags
	flags

uint8_t	m_hopcount
	hop count

uint32_t	m_lifetime
	lifetime

uint32_t	m_metric
	metric

Mac48Address	m_originatorAddress
	originator address

uint32_t	m_originatorSeqNumber
	originator sequence number

uint8_t	m_ttl
	TTL.

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

Detailed Description

See 7.3.2.97 of 802.11s draft 2.07.

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

Constructor & Destructor Documentation

◆ IePrep()

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

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

◆ ~IePrep()

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

override

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

Member Function Documentation

◆ DecrementTtl()

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

Decrement TTL function.

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

References m_hopcount, and m_ttl.

◆ DeserializeInformationField()

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

overridevirtual

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

Parameters

start	an iterator which points to where the information should be written.
length	the expected number of bytes to read

Returns: the number of bytes read

Implements ns3::WifiInformationElement.

Definition at line 181 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(), and ns3::Buffer::Iterator::ReadU8().

Here is the call graph for this function:

◆ ElementId()

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

overridevirtual

Get the wifi information element ID.

Returns: the wifi information element ID

Implements ns3::WifiInformationElement.

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

References IE_PREP.

◆ GetDestinationAddress()

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

Get destination address function.

Returns: the destination MAC address

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

References m_destinationAddress.

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

Here is the caller graph for this function:

◆ GetDestinationSeqNumber()

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

Get destination sequence number function.

Returns: the destination sequence number

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

References m_destSeqNumber.

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

Here is the caller graph for this function:

◆ GetFlags()

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

Get flags function.

Returns: the flags

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

References m_flags.

◆ GetHopcount()

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

Get hop count function.

Returns: the hop count

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

References m_hopcount.

◆ GetInformationFieldSize()

uint16_t ns3::dot11s::IePrep::GetInformationFieldSize ( ) const

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)

Returns: the length of serialized information

Implements ns3::WifiInformationElement.

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

◆ GetLifetime()

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

Get lifetime function.

Returns: the lifetime

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

References m_lifetime.

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

Here is the caller graph for this function:

◆ GetMetric()

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

Get metric function.

Returns: the metric

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

References m_metric.

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

Here is the caller graph for this function:

◆ GetOriginatorAddress()

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

Get originator address function.

Returns: the MAC address of the originator

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

References m_originatorAddress.

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

Here is the caller graph for this function:

◆ GetOriginatorSeqNumber()

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

Get originator sequence number.

Returns: the originator sequence number

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

References m_originatorSeqNumber.

◆ GetTtl()

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

Get TTL function.

Returns: the TTL

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

References m_ttl.

◆ IncrementMetric()

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

Increment metric function.

Parameters

metric the metric to increment

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

References m_metric.

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

Here is the caller graph for this function:

◆ Print()

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

overridevirtual

Generate human-readable form of IE.

Parameters

os	output stream

Reimplemented from ns3::WifiInformationElement.

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

References 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 caller graph for this function:

◆ SerializeInformationField()

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

overridevirtual

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

Parameters

start an iterator which points to where the information should be written.

Implements ns3::WifiInformationElement.

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

◆ SetDestinationAddress()

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

Set destination address function.

Parameters

dest_address

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

References m_destinationAddress.

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

Here is the caller graph for this function:

◆ SetDestinationSeqNumber()

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

Set destination sequence number function.

Parameters

dest_seq_number the destination sequence number

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

References m_destSeqNumber.

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

Here is the caller graph for this function:

◆ SetFlags()

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

Set flags function.

Parameters

flags the flags to set

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

References m_flags.

◆ SetHopcount()

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

Set hop count function.

Parameters

hopcount the hop count

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

References m_hopcount.

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

Here is the caller graph for this function:

◆ SetLifetime()

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

Set lifetime function.

Parameters

lifetime the lifetime

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

References m_lifetime.

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

Here is the caller graph for this function:

◆ SetMetric()

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

Set metric function.

Parameters

metric the metric to set

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

References m_metric.

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

Here is the caller graph for this function:

◆ SetOriginatorAddress()

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

Set originator address function.

Parameters

originator_address the originator address

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

References m_originatorAddress.

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

Here is the caller graph for this function:

◆ SetOriginatorSeqNumber()

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

Set originator sequence number function.

Parameters

originator_seq_number the originator sequence number

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

References m_originatorSeqNumber.

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

Here is the caller graph for this function:

◆ SetTtl()

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

Set TTL function.

Parameters

ttl the TTL

Definition at line 58 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 Symbol Documentation

◆ operator==

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

friend

equality operator

Parameters

a	lhs
b	rhs

Returns: true if equal

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

Member Data Documentation

◆ m_destinationAddress

Mac48Address ns3::dot11s::IePrep::m_destinationAddress

private

destination address

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

Referenced by DeserializeInformationField(), GetDestinationAddress(), Print(), SerializeInformationField(), and SetDestinationAddress().

◆ m_destSeqNumber

uint32_t ns3::dot11s::IePrep::m_destSeqNumber

private

destination sequence number

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

Referenced by DeserializeInformationField(), GetDestinationSeqNumber(), Print(), SerializeInformationField(), and SetDestinationSeqNumber().

◆ m_flags

uint8_t ns3::dot11s::IePrep::m_flags

private

flags

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

Referenced by DeserializeInformationField(), GetFlags(), Print(), SerializeInformationField(), and SetFlags().

◆ m_hopcount

uint8_t ns3::dot11s::IePrep::m_hopcount

private

hop count

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

Referenced by DecrementTtl(), DeserializeInformationField(), GetHopcount(), Print(), SerializeInformationField(), and SetHopcount().

◆ m_lifetime

uint32_t ns3::dot11s::IePrep::m_lifetime

private

lifetime

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

Referenced by DeserializeInformationField(), GetLifetime(), Print(), SerializeInformationField(), and SetLifetime().

◆ m_metric

uint32_t ns3::dot11s::IePrep::m_metric

private

metric

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

Referenced by DeserializeInformationField(), GetMetric(), IncrementMetric(), Print(), SerializeInformationField(), and SetMetric().

◆ m_originatorAddress

Mac48Address ns3::dot11s::IePrep::m_originatorAddress

private

originator address

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

Referenced by DeserializeInformationField(), GetOriginatorAddress(), Print(), SerializeInformationField(), and SetOriginatorAddress().

◆ m_originatorSeqNumber

uint32_t ns3::dot11s::IePrep::m_originatorSeqNumber

private

originator sequence number

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

Referenced by DeserializeInformationField(), GetOriginatorSeqNumber(), Print(), SerializeInformationField(), and SetOriginatorSeqNumber().

◆ m_ttl

uint8_t ns3::dot11s::IePrep::m_ttl

private

TTL.

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

Referenced by DecrementTtl(), DeserializeInformationField(), GetTtl(), Print(), SerializeInformationField(), and SetTtl().

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

src/mesh/model/dot11s/ie-dot11s-prep.h
src/mesh/model/dot11s/ie-dot11s-prep.cc

Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ IePrep()

◆ ~IePrep()

Member Function Documentation

◆ DecrementTtl()

◆ DeserializeInformationField()

◆ ElementId()

◆ GetDestinationAddress()

◆ GetDestinationSeqNumber()

◆ GetFlags()

◆ GetHopcount()

◆ GetInformationFieldSize()

◆ GetLifetime()

◆ GetMetric()

◆ GetOriginatorAddress()

◆ GetOriginatorSeqNumber()

◆ GetTtl()

◆ IncrementMetric()

◆ Print()

◆ SerializeInformationField()

◆ SetDestinationAddress()

◆ SetDestinationSeqNumber()

◆ SetFlags()

◆ SetHopcount()

◆ SetLifetime()

◆ SetMetric()

◆ SetOriginatorAddress()

◆ SetOriginatorSeqNumber()

◆ SetTtl()

Friends And Related Symbol Documentation

◆ operator==

Member Data Documentation

◆ m_destinationAddress

◆ m_destSeqNumber

◆ m_flags

◆ m_hopcount

◆ m_lifetime

◆ m_metric

◆ m_originatorAddress

◆ m_originatorSeqNumber

◆ m_ttl