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

Implement the header for management frames of type association request. More...

#include "mgt-headers.h"

+ Inheritance diagram for ns3::MgtAssocRequestHeader:
+ Collaboration diagram for ns3::MgtAssocRequestHeader:

Public Member Functions

 MgtAssocRequestHeader ()
 
 ~MgtAssocRequestHeader ()
 
uint32_t Deserialize (Buffer::Iterator start)
 
CapabilityInformation GetCapabilities (void) const
 Return the Capability information. More...
 
ExtendedCapabilities GetExtendedCapabilities (void) const
 Return the extended capabilities. More...
 
HeCapabilities GetHeCapabilities (void) const
 Return the HE capabilities. More...
 
HtCapabilities GetHtCapabilities (void) const
 Return the HT capabilities. More...
 
TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
uint16_t GetListenInterval (void) const
 Return the listen interval. More...
 
uint32_t GetSerializedSize (void) const
 
Ssid GetSsid (void) const
 Return the Service Set Identifier (SSID). More...
 
SupportedRates GetSupportedRates (void) const
 Return the supported rates. More...
 
VhtCapabilities GetVhtCapabilities (void) const
 Return the VHT capabilities. More...
 
void Print (std::ostream &os) const
 
void Serialize (Buffer::Iterator start) const
 
void SetCapabilities (CapabilityInformation capabilities)
 Set the Capability information. More...
 
void SetExtendedCapabilities (ExtendedCapabilities extendedcapabilities)
 Set the Extended Capabilities. More...
 
void SetHeCapabilities (HeCapabilities hecapabilities)
 Set the HE capabilities. More...
 
void SetHtCapabilities (HtCapabilities htcapabilities)
 Set the HT capabilities. More...
 
void SetListenInterval (uint16_t interval)
 Set the listen interval. More...
 
void SetSsid (Ssid ssid)
 Set the Service Set Identifier (SSID). More...
 
void SetSupportedRates (SupportedRates rates)
 Set the supported rates. More...
 
void SetVhtCapabilities (VhtCapabilities vhtcapabilities)
 Set the VHT capabilities. More...
 
- Public Member Functions inherited from ns3::Header
virtual ~Header ()
 
- Public Member Functions inherited from ns3::Chunk
virtual uint32_t Deserialize (Buffer::Iterator start, Buffer::Iterator end)
 Deserialize the object from a buffer iterator. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::Header
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Chunk
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

CapabilityInformation m_capability
 Capability information. More...
 
ExtendedCapabilities m_extendedCapability
 Extended capabilities. More...
 
HeCapabilities m_heCapability
 HE capabilities. More...
 
HtCapabilities m_htCapability
 HT capabilities. More...
 
uint16_t m_listenInterval
 listen interval More...
 
SupportedRates m_rates
 List of supported rates. More...
 
Ssid m_ssid
 Service Set ID (SSID) More...
 
VhtCapabilities m_vhtCapability
 VHT capabilities. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

Implement the header for management frames of type association request.

Introspection did not find any typical Config paths.


No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 616 bytes (on a 64-bit architecture).

Definition at line 49 of file mgt-headers.h.

Constructor & Destructor Documentation

ns3::MgtAssocRequestHeader::MgtAssocRequestHeader ( )

Definition at line 526 of file mgt-headers.cc.

ns3::MgtAssocRequestHeader::~MgtAssocRequestHeader ( )

Definition at line 531 of file mgt-headers.cc.

Member Function Documentation

uint32_t ns3::MgtAssocRequestHeader::Deserialize ( Buffer::Iterator  start)
virtual
Parameters
startan iterator which points to where the header should read from.
Returns
the number of bytes read.

This method is used by Packet::RemoveHeader to re-create a header from the byte buffer of a packet. The data read is expected to match bit-for-bit the representation of this header in real networks.

Note that data is not actually removed from the buffer to which the iterator points. Both Packet::RemoveHeader() and Packet::PeekHeader() call Deserialize(), but only the RemoveHeader() has additional statements to remove the header bytes from the underlying buffer and associated metadata.

Implements ns3::Header.

Definition at line 691 of file mgt-headers.cc.

References ns3::CapabilityInformation::Deserialize(), ns3::WifiInformationElement::Deserialize(), ns3::WifiInformationElement::DeserializeIfPresent(), ns3::SupportedRates::extended, ns3::Buffer::Iterator::GetDistanceFrom(), m_capability, m_extendedCapability, m_heCapability, m_htCapability, m_listenInterval, m_rates, m_ssid, m_vhtCapability, NS_OBJECT_ENSURE_REGISTERED, ns3::Buffer::Iterator::ReadLsbtohU16(), and visualizer.core::start().

+ Here is the call graph for this function:

CapabilityInformation ns3::MgtAssocRequestHeader::GetCapabilities ( void  ) const

Return the Capability information.

Returns
Capability information

Definition at line 560 of file mgt-headers.cc.

References m_capability.

Referenced by ns3::ApWifiMac::Receive().

+ Here is the caller graph for this function:

ExtendedCapabilities ns3::MgtAssocRequestHeader::GetExtendedCapabilities ( void  ) const

Return the extended capabilities.

Returns
the extended capabilities

Definition at line 572 of file mgt-headers.cc.

References m_extendedCapability.

Referenced by ns3::ApWifiMac::Receive().

+ Here is the caller graph for this function:

HeCapabilities ns3::MgtAssocRequestHeader::GetHeCapabilities ( void  ) const

Return the HE capabilities.

Returns
HE capabilities

Definition at line 608 of file mgt-headers.cc.

References m_heCapability.

Referenced by ns3::ApWifiMac::Receive().

+ Here is the caller graph for this function:

HtCapabilities ns3::MgtAssocRequestHeader::GetHtCapabilities ( void  ) const

Return the HT capabilities.

Returns
HT capabilities

Definition at line 584 of file mgt-headers.cc.

References m_htCapability.

Referenced by ns3::ApWifiMac::Receive().

+ Here is the caller graph for this function:

TypeId ns3::MgtAssocRequestHeader::GetInstanceTypeId ( void  ) const
virtual

Get the most derived TypeId for this Object.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Returns
The TypeId associated to the most-derived type of this instance.

Implements ns3::ObjectBase.

Definition at line 643 of file mgt-headers.cc.

References GetTypeId().

+ Here is the call graph for this function:

uint16_t ns3::MgtAssocRequestHeader::GetListenInterval ( void  ) const

Return the listen interval.

Returns
the listen interval

Definition at line 626 of file mgt-headers.cc.

References m_listenInterval.

uint32_t ns3::MgtAssocRequestHeader::GetSerializedSize ( void  ) const
virtual
Returns
the expected size of the header.

This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. This method should return the number of bytes which are needed to store the full header data by Serialize.

Implements ns3::Header.

Definition at line 649 of file mgt-headers.cc.

References ns3::SupportedRates::extended, ns3::ExtendedSupportedRatesIE::GetSerializedSize(), ns3::CapabilityInformation::GetSerializedSize(), ns3::ExtendedCapabilities::GetSerializedSize(), ns3::HeCapabilities::GetSerializedSize(), ns3::VhtCapabilities::GetSerializedSize(), ns3::WifiInformationElement::GetSerializedSize(), ns3::HtCapabilities::GetSerializedSize(), m_capability, m_extendedCapability, m_heCapability, m_htCapability, m_rates, m_ssid, and m_vhtCapability.

+ Here is the call graph for this function:

Ssid ns3::MgtAssocRequestHeader::GetSsid ( void  ) const

Return the Service Set Identifier (SSID).

Returns
SSID

Definition at line 614 of file mgt-headers.cc.

References m_ssid.

SupportedRates ns3::MgtAssocRequestHeader::GetSupportedRates ( void  ) const

Return the supported rates.

Returns
the supported rates

Definition at line 620 of file mgt-headers.cc.

References m_rates.

Referenced by ns3::ApWifiMac::Receive().

+ Here is the caller graph for this function:

TypeId ns3::MgtAssocRequestHeader::GetTypeId ( void  )
static

Register this type.

Returns
The TypeId.

Definition at line 632 of file mgt-headers.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

VhtCapabilities ns3::MgtAssocRequestHeader::GetVhtCapabilities ( void  ) const

Return the VHT capabilities.

Returns
VHT capabilities

Definition at line 596 of file mgt-headers.cc.

References m_vhtCapability.

Referenced by ns3::ApWifiMac::Receive().

+ Here is the caller graph for this function:

void ns3::MgtAssocRequestHeader::Print ( std::ostream &  os) const
virtual
Parameters
osoutput stream This method is used by Packet::Print to print the content of a header as ascii data to a c++ output stream. Although the header is free to format its output as it wishes, it is recommended to follow a few rules to integrate with the packet pretty printer: start with flags, small field values located between a pair of parens. Values should be separated by whitespace. Follow the parens with the important fields, separated by whitespace. i.e.: (field1 val1 field2 val2 field3 val3) field4 val4 field5 val5

Implements ns3::Header.

Definition at line 665 of file mgt-headers.cc.

References m_extendedCapability, m_heCapability, m_htCapability, m_rates, m_ssid, and m_vhtCapability.

void ns3::MgtAssocRequestHeader::Serialize ( Buffer::Iterator  start) const
virtual
Parameters
startan iterator which points to where the header should be written.

This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. The data written is expected to match bit-for-bit the representation of this header in a real network.

Implements ns3::Header.

Definition at line 676 of file mgt-headers.cc.

References ns3::SupportedRates::extended, m_capability, m_extendedCapability, m_heCapability, m_htCapability, m_listenInterval, m_rates, m_ssid, m_vhtCapability, ns3::ExtendedSupportedRatesIE::Serialize(), ns3::CapabilityInformation::Serialize(), ns3::ExtendedCapabilities::Serialize(), ns3::HeCapabilities::Serialize(), ns3::VhtCapabilities::Serialize(), ns3::WifiInformationElement::Serialize(), ns3::HtCapabilities::Serialize(), visualizer.core::start(), and ns3::Buffer::Iterator::WriteHtolsbU16().

+ Here is the call graph for this function:

void ns3::MgtAssocRequestHeader::SetCapabilities ( CapabilityInformation  capabilities)

Set the Capability information.

Parameters
capabilitiesCapability information

Definition at line 554 of file mgt-headers.cc.

References m_capability.

Referenced by ns3::StaWifiMac::SendAssociationRequest().

+ Here is the caller graph for this function:

void ns3::MgtAssocRequestHeader::SetExtendedCapabilities ( ExtendedCapabilities  extendedcapabilities)

Set the Extended Capabilities.

Parameters
extendedcapabilitiesthe Extended Capabilities

Definition at line 566 of file mgt-headers.cc.

References m_extendedCapability.

Referenced by ns3::StaWifiMac::SendAssociationRequest().

+ Here is the caller graph for this function:

void ns3::MgtAssocRequestHeader::SetHeCapabilities ( HeCapabilities  hecapabilities)

Set the HE capabilities.

Parameters
hecapabilitiesHE capabilities

Definition at line 602 of file mgt-headers.cc.

References m_heCapability.

Referenced by ns3::StaWifiMac::SendAssociationRequest().

+ Here is the caller graph for this function:

void ns3::MgtAssocRequestHeader::SetHtCapabilities ( HtCapabilities  htcapabilities)

Set the HT capabilities.

Parameters
htcapabilitiesHT capabilities

Definition at line 578 of file mgt-headers.cc.

References m_htCapability.

Referenced by ns3::StaWifiMac::SendAssociationRequest().

+ Here is the caller graph for this function:

void ns3::MgtAssocRequestHeader::SetListenInterval ( uint16_t  interval)

Set the listen interval.

Parameters
intervalthe listen interval

Definition at line 548 of file mgt-headers.cc.

References m_listenInterval.

Referenced by ns3::StaWifiMac::SendAssociationRequest().

+ Here is the caller graph for this function:

void ns3::MgtAssocRequestHeader::SetSsid ( Ssid  ssid)

Set the Service Set Identifier (SSID).

Parameters
ssidSSID

Definition at line 536 of file mgt-headers.cc.

References m_ssid, and third::ssid.

Referenced by ns3::StaWifiMac::SendAssociationRequest().

+ Here is the caller graph for this function:

void ns3::MgtAssocRequestHeader::SetSupportedRates ( SupportedRates  rates)

Set the supported rates.

Parameters
ratesthe supported rates

Definition at line 542 of file mgt-headers.cc.

References m_rates.

Referenced by ns3::StaWifiMac::SendAssociationRequest().

+ Here is the caller graph for this function:

void ns3::MgtAssocRequestHeader::SetVhtCapabilities ( VhtCapabilities  vhtcapabilities)

Set the VHT capabilities.

Parameters
vhtcapabilitiesVHT capabilities

Definition at line 590 of file mgt-headers.cc.

References m_vhtCapability.

Referenced by ns3::StaWifiMac::SendAssociationRequest().

+ Here is the caller graph for this function:

Member Data Documentation

CapabilityInformation ns3::MgtAssocRequestHeader::m_capability
private

Capability information.

Definition at line 167 of file mgt-headers.h.

Referenced by Deserialize(), GetCapabilities(), GetSerializedSize(), Serialize(), and SetCapabilities().

ExtendedCapabilities ns3::MgtAssocRequestHeader::m_extendedCapability
private

Extended capabilities.

Definition at line 168 of file mgt-headers.h.

Referenced by Deserialize(), GetExtendedCapabilities(), GetSerializedSize(), Print(), Serialize(), and SetExtendedCapabilities().

HeCapabilities ns3::MgtAssocRequestHeader::m_heCapability
private

HE capabilities.

Definition at line 171 of file mgt-headers.h.

Referenced by Deserialize(), GetHeCapabilities(), GetSerializedSize(), Print(), Serialize(), and SetHeCapabilities().

HtCapabilities ns3::MgtAssocRequestHeader::m_htCapability
private

HT capabilities.

Definition at line 169 of file mgt-headers.h.

Referenced by Deserialize(), GetHtCapabilities(), GetSerializedSize(), Print(), Serialize(), and SetHtCapabilities().

uint16_t ns3::MgtAssocRequestHeader::m_listenInterval
private

listen interval

Definition at line 172 of file mgt-headers.h.

Referenced by Deserialize(), GetListenInterval(), Serialize(), and SetListenInterval().

SupportedRates ns3::MgtAssocRequestHeader::m_rates
private

List of supported rates.

Definition at line 166 of file mgt-headers.h.

Referenced by Deserialize(), GetSerializedSize(), GetSupportedRates(), Print(), Serialize(), and SetSupportedRates().

Ssid ns3::MgtAssocRequestHeader::m_ssid
private

Service Set ID (SSID)

Definition at line 165 of file mgt-headers.h.

Referenced by Deserialize(), GetSerializedSize(), GetSsid(), Print(), Serialize(), and SetSsid().

VhtCapabilities ns3::MgtAssocRequestHeader::m_vhtCapability
private

VHT capabilities.

Definition at line 170 of file mgt-headers.h.

Referenced by Deserialize(), GetSerializedSize(), GetVhtCapabilities(), Print(), Serialize(), and SetVhtCapabilities().


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