A Discrete-Event Network Simulator
API
ns3::Ssid Class Reference

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. More...
 
 Ssid (std::string s)
 Create SSID from a given string. More...
 
WifiInformationElementId ElementId () const override
 Get the wifi information element ID. More...
 
bool IsBroadcast (void) const
 Check if the SSID is broadcast. More...
 
bool IsEqual (const Ssid &o) const
 Check if the two SSIDs are equal. More...
 
char * PeekString (void) const
 Peek the SSID. More...
 
- 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. More...
 
virtual WifiInformationElementId ElementId () const =0
 Get the wifi information element ID. More...
 
virtual WifiInformationElementId ElementIdExt () const
 Get the wifi information element ID extension. More...
 
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). More...
 
virtual bool operator== (WifiInformationElement const &a) const
 Compare two IEs for equality by ID & Length, and then through memcmp of serialised version. More...
 
virtual void Print (std::ostream &os) const
 Generate human-readable form of IE. More...
 
Buffer::Iterator Serialize (Buffer::Iterator i) const
 Serialize entire IE including Element ID and length fields. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< WifiInformationElement >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 

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) More...
 
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. More...
 
void SerializeInformationField (Buffer::Iterator start) const override
 Serialize information (i.e., the body of the IE, not including the Element ID and length octets) More...
 

Private Attributes

uint8_t m_length
 Length of the SSID. More...
 
uint8_t m_ssid [33]
 Raw SSID value. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ns3::WifiInformationElement
template<typename IE , typename... Args>
static Buffer::Iterator DeserializeIfPresent (std::optional< IE > &optElem, Buffer::Iterator i, Args &&... args)
 Deserialize an entire IE (which may possibly be fragmented into multiple elements) that is optionally present. More...
 

Detailed Description

The IEEE 802.11 SSID Information Element.

See also
Ssid Attribute

Definition at line 35 of file ssid.h.

Constructor & Destructor Documentation

◆ Ssid() [1/2]

ns3::Ssid::Ssid ( )

Create SSID with broadcast SSID.

Definition at line 25 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
sSSID in string

Definition at line 34 of file ssid.cc.

References m_length, m_ssid, NS_ASSERT, and third::ssid.

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
startan iterator which points to where the information should be written.
lengththe expected number of bytes to read
Returns
the number of bytes read

Implements ns3::WifiInformationElement.

Definition at line 109 of file ssid.cc.

References m_length, m_ssid, NS_ASSERT, and visualizer.core::start().

+ Here is the call graph for this function:

◆ 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 90 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 96 of file ssid.cc.

References m_length.

◆ IsBroadcast()

bool ns3::Ssid::IsBroadcast ( void  ) const

Check if the SSID is broadcast.

Returns
true if the SSID is broadcast, false otherwise

Definition at line 72 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
oSSID to compare to
Returns
true if the two SSIDs are equal, false otherwise

Definition at line 55 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 ( void  ) const

Peek the SSID.

Returns
a pointer to SSID string

Definition at line 82 of file ssid.cc.

References m_ssid.

◆ 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
startan iterator which points to where the information should be written.

Implements ns3::WifiInformationElement.

Definition at line 102 of file ssid.cc.

References m_length, m_ssid, NS_ASSERT, and visualizer.core::start().

+ Here is the call graph for this function:

Member Data Documentation

◆ m_length

uint8_t ns3::Ssid::m_length
private

Length of the SSID.

Definition at line 84 of file ssid.h.

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

◆ m_ssid

uint8_t ns3::Ssid::m_ssid[33]
private

Raw SSID value.

Definition at line 83 of file ssid.h.

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


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