a IEEE 802.11 Mesh ID element (Section 8.4.2.101 of IEEE 802.11-2012) More...

#include "ie-dot11s-id.h"

Inheritance diagram for ns3::dot11s::IeMeshId:

Collaboration diagram for ns3::dot11s::IeMeshId:

Public Member Functions
	IeMeshId ()

	IeMeshId (std::string s)
	Constructor.

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.

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.

bool	IsBroadcast () const
	Return true if broadcast (if first octet of Mesh ID is zero)

bool	IsEqual (const IeMeshId &o) const
	Equality test.

char *	PeekString () const
	Peek the IeMeshId as a string value.

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)

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
uint8_t	m_meshId [33]
	mesh ID

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

Detailed Description

a IEEE 802.11 Mesh ID element (Section 8.4.2.101 of IEEE 802.11-2012)

Definition at line 25 of file ie-dot11s-id.h.

Constructor & Destructor Documentation

◆ IeMeshId() [1/2]

ns3::dot11s::IeMeshId::IeMeshId ( )

Definition at line 18 of file ie-dot11s-id.cc.

References m_meshId.

◆ IeMeshId() [2/2]

ns3::dot11s::IeMeshId::IeMeshId ( std::string s )

Constructor.

Parameters

s	reference id

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

References m_meshId, and NS_ASSERT.

Member Function Documentation

◆ DeserializeInformationField()

uint16_t ns3::dot11s::IeMeshId::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 98 of file ie-dot11s-id.cc.

References ns3::Buffer::Iterator::GetDistanceFrom(), m_meshId, NS_ASSERT, and ns3::Buffer::Iterator::Read().

Referenced by ns3::dot11s::PeerLinkCloseStart::Deserialize(), and ns3::dot11s::PeerLinkOpenStart::Deserialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ElementId()

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

overridevirtual

Get the wifi information element ID.

Returns: the wifi information element ID

Implements ns3::WifiInformationElement.

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

References IE_MESH_ID.

Referenced by ns3::dot11s::PeerLinkCloseStart::Deserialize(), and ns3::dot11s::PeerLinkOpenStart::Deserialize().

Here is the caller graph for this function:

◆ GetInformationFieldSize()

uint16_t ns3::dot11s::IeMeshId::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 75 of file ie-dot11s-id.cc.

References m_meshId, and NS_ASSERT.

Referenced by ns3::dot11s::PeerLinkCloseStart::Deserialize(), ns3::dot11s::PeerLinkOpenStart::Deserialize(), ns3::dot11s::PeerLinkCloseStart::GetSerializedSize(), and ns3::dot11s::PeerLinkOpenStart::GetSerializedSize().

Here is the caller graph for this function:

◆ IsBroadcast()

bool ns3::dot11s::IeMeshId::IsBroadcast ( ) const

Return true if broadcast (if first octet of Mesh ID is zero)

Returns: true if broadcast

Definition at line 63 of file ie-dot11s-id.cc.

References m_meshId.

◆ IsEqual()

bool ns3::dot11s::IeMeshId::IsEqual ( const IeMeshId & o ) const

Equality test.

Parameters

o	another IeMeshId

Returns: true if equal

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

References m_meshId.

Referenced by ns3::dot11s::PeerManagementProtocolMac::Receive().

Here is the caller graph for this function:

◆ PeekString()

char * ns3::dot11s::IeMeshId::PeekString ( ) const

Peek the IeMeshId as a string value.

Returns: the mesh ID as a string

Definition at line 69 of file ie-dot11s-id.cc.

References m_meshId.

Referenced by Print().

Here is the caller graph for this function:

◆ Print()

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

overridevirtual

Generate human-readable form of IE.

Parameters

os	output stream

Reimplemented from ns3::WifiInformationElement.

Definition at line 108 of file ie-dot11s-id.cc.

References PeekString().

Referenced by ns3::dot11s::operator<<(), ns3::dot11s::PeerLinkCloseStart::Print(), and ns3::dot11s::PeerLinkOpenStart::Print().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SerializeInformationField()

void ns3::dot11s::IeMeshId::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 87 of file ie-dot11s-id.cc.

References m_meshId, and ns3::Buffer::Iterator::WriteU8().

Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ operator==

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

friend

equality operator

Parameters

a	lhs
b	lhs

Returns: true if equal

Definition at line 114 of file ie-dot11s-id.cc.

Member Data Documentation

◆ m_meshId

uint8_t ns3::dot11s::IeMeshId::m_meshId[33]

private

mesh ID

Definition at line 63 of file ie-dot11s-id.h.

Referenced by IeMeshId(), IeMeshId(), DeserializeInformationField(), GetInformationFieldSize(), IsBroadcast(), IsEqual(), PeekString(), and SerializeInformationField().

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

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

Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ IeMeshId() [1/2]

◆ IeMeshId() [2/2]

Member Function Documentation

◆ DeserializeInformationField()

◆ ElementId()

◆ GetInformationFieldSize()

◆ IsBroadcast()

◆ IsEqual()

◆ PeekString()

◆ Print()

◆ SerializeInformationField()

Friends And Related Symbol Documentation

◆ operator==

Member Data Documentation

◆ m_meshId