The IEEE 802.11 SSID Information Element. More...

#include "ssid.h"

Inheritance diagram for ns3::Ssid:

Collaboration diagram for ns3::Ssid:

Public Member Functions
	Ssid ()
	Create SSID with broadcast SSID.

	Ssid (std::string s)
	Create SSID from a given string.

WifiInformationElementId	ElementId () const override
	Get the wifi information element ID.

bool	IsBroadcast () const
	Check if the SSID is broadcast.

bool	IsEqual (const Ssid &o) const
	Check if the two SSIDs are equal.

char *	PeekString () const
	Peek the SSID.

void	Print (std::ostream &os) const override
	Generate human-readable form of IE.

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 Member Functions
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)

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.

void	SerializeInformationField (Buffer::Iterator start) const override
	Serialize information (i.e., the body of the IE, not including the Element ID and length octets)

Private Attributes
uint8_t	m_length
	Length of the SSID.

uint8_t	m_ssid [33]
	Raw SSID value.

Detailed Description

The IEEE 802.11 SSID Information Element.

See also: attribute_Ssid

Definition at line 24 of file ssid.h.

Constructor & Destructor Documentation

◆ Ssid() [1/2]

ns3::Ssid::Ssid ( )

Create SSID with broadcast SSID.

Definition at line 14 of file ssid.cc.

References m_length, and m_ssid.

◆ Ssid() [2/2]

ns3::Ssid::Ssid ( std::string s )

Create SSID from a given string.

Parameters

s	SSID in string

Definition at line 23 of file ssid.cc.

References m_length, m_ssid, and NS_ASSERT.

Member Function Documentation

◆ DeserializeInformationField()

uint16_t ns3::Ssid::DeserializeInformationField	(	Buffer::Iterator	start,
		uint16_t	length )

overrideprivatevirtual

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 94 of file ssid.cc.

References m_length, m_ssid, and NS_ASSERT.

◆ ElementId()

WifiInformationElementId ns3::Ssid::ElementId ( ) const

overridevirtual

Get the wifi information element ID.

Returns: the wifi information element ID

Implements ns3::WifiInformationElement.

Definition at line 75 of file ssid.cc.

References IE_SSID.

◆ GetInformationFieldSize()

uint16_t ns3::Ssid::GetInformationFieldSize ( ) const

overrideprivatevirtual

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 81 of file ssid.cc.

References m_length.

◆ IsBroadcast()

bool ns3::Ssid::IsBroadcast ( ) const

Check if the SSID is broadcast.

Returns: true if the SSID is broadcast, false otherwise

Definition at line 61 of file ssid.cc.

References m_ssid.

Referenced by ns3::WifiAssocManager::MatchScanParams().

Here is the caller graph for this function:

◆ IsEqual()

bool ns3::Ssid::IsEqual ( const Ssid & o ) const

Check if the two SSIDs are equal.

Parameters

o	SSID to compare to

Returns: true if the two SSIDs are equal, false otherwise

Definition at line 50 of file ssid.cc.

References m_ssid.

Referenced by ns3::WifiAssocManager::MatchScanParams(), and ns3::MeshWifiInterfaceMac::Receive().

Here is the caller graph for this function:

◆ PeekString()

char * ns3::Ssid::PeekString ( ) const

Peek the SSID.

Returns: a pointer to SSID string

Definition at line 67 of file ssid.cc.

References m_ssid.

Referenced by WifiMgtHeaderTest::DoRun(), and Print().

Here is the caller graph for this function:

◆ Print()

void ns3::Ssid::Print ( std::ostream & os ) const

overridevirtual

Generate human-readable form of IE.

Parameters

os	output stream

Reimplemented from ns3::WifiInformationElement.

Definition at line 44 of file ssid.cc.

References PeekString().

Here is the call graph for this function:

◆ SerializeInformationField()

void ns3::Ssid::SerializeInformationField ( Buffer::Iterator start ) const

overrideprivatevirtual

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 ssid.cc.

References m_length, m_ssid, and NS_ASSERT.

Member Data Documentation

◆ m_length

uint8_t ns3::Ssid::m_length

private

Length of the SSID.

Definition at line 72 of file ssid.h.

Referenced by Ssid(), Ssid(), DeserializeInformationField(), GetInformationFieldSize(), and SerializeInformationField().

◆ m_ssid

uint8_t ns3::Ssid::m_ssid[33]

private

Raw SSID value.

Definition at line 71 of file ssid.h.

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

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

src/wifi/model/ssid.h
src/wifi/model/ssid.cc

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Ssid() [1/2]

◆ Ssid() [2/2]

Member Function Documentation

◆ DeserializeInformationField()

◆ ElementId()

◆ GetInformationFieldSize()

◆ IsBroadcast()

◆ IsEqual()

◆ PeekString()

◆ Print()

◆ SerializeInformationField()

Member Data Documentation

◆ m_length

◆ m_ssid