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 ()
 
 Ssid (std::string s)
 Create SSID from a given string. More...
 
uint8_t DeserializeInformationField (Buffer::Iterator start, uint8_t length)
 Get the information field size. More...
 
WifiInformationElementId ElementId () const
 Get the ElementID. More...
 
uint8_t GetInformationFieldSize () const
 Get the information field size. 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...
 
void SerializeInformationField (Buffer::Iterator start) const
 Get the information field size. 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...
 
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 Attributes

uint8_t m_length
 Length of the SSID. More...
 
uint8_t m_ssid [33]
 Raw SSID value. 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

ns3::Ssid::Ssid ( )

Definition at line 25 of file ssid.cc.

References m_length, and m_ssid.

Referenced by ns3::operator>>().

+ Here is the caller graph for this function:

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

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

Get the information field size.

Parameters
startthe information field iterator
lengththe size of the information field
Returns
the size of the field read

Implements ns3::WifiInformationElement.

Definition at line 109 of file ssid.cc.

References m_length, m_ssid, NS_ASSERT, and ns3::Buffer::Iterator::Read().

+ Here is the call graph for this function:

WifiInformationElementId ns3::Ssid::ElementId ( ) const
virtual

Get the ElementID.

Returns
the element ID

Implements ns3::WifiInformationElement.

Definition at line 90 of file ssid.cc.

References IE_SSID.

uint8_t ns3::Ssid::GetInformationFieldSize ( void  ) const
virtual

Get the information field size.

Returns
the information field size

Implements ns3::WifiInformationElement.

Definition at line 96 of file ssid.cc.

References m_length.

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::StaWifiMac::Receive().

+ Here is the caller graph for this function:

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::StaWifiMac::Receive(), and ns3::MeshWifiInterfaceMac::Receive().

+ Here is the caller graph for this function:

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.

Referenced by ns3::operator<<().

+ Here is the caller graph for this function:

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

Get the information field size.

Parameters
startthe information field iterator

Implements ns3::WifiInformationElement.

Definition at line 102 of file ssid.cc.

References m_length, m_ssid, NS_ASSERT, and ns3::Buffer::Iterator::Write().

+ Here is the call graph for this function:

Member Data Documentation

uint8_t ns3::Ssid::m_length
private

Length of the SSID.

Definition at line 104 of file ssid.h.

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

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

Raw SSID value.

Definition at line 103 of file ssid.h.

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


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