A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::MgtProbeResponseHeader Class Reference

Implement the header for management frames of type probe response. More...

#include <mgt-headers.h>

+ Inheritance diagram for ns3::MgtProbeResponseHeader:
+ Collaboration diagram for ns3::MgtProbeResponseHeader:

Public Member Functions

 MgtProbeResponseHeader ()
 
 ~MgtProbeResponseHeader ()
 
virtual uint32_t Deserialize (Buffer::Iterator start)
 
uint64_t GetBeaconIntervalUs (void) const
 Return the beacon interval in microseconds unit. More...
 
HtCapabilities GetHtCapabilities (void) const
 Return the HT capabilities. More...
 
virtual TypeId GetInstanceTypeId (void) const
 
virtual 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...
 
uint64_t GetTimestamp ()
 Return the time stamp. More...
 
virtual void Print (std::ostream &os) const
 
virtual void Serialize (Buffer::Iterator start) const
 
void SetBeaconIntervalUs (uint64_t us)
 Set the beacon interval in microseconds unit. More...
 
void SetHtCapabilities (HtCapabilities htcapabilities)
 Set the HT capabilities. More...
 
void SetSsid (Ssid ssid)
 Set the Service Set Identifier (SSID). More...
 
void SetSupportedRates (SupportedRates rates)
 Set the supported rates. More...
 
- Public Member Functions inherited from ns3::Header
virtual ~Header ()
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 

Static Public Member Functions

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

Private Attributes

uint64_t m_beaconInterval
 Beacon interval. More...
 
CapabilityInformation m_capability
 Capability information. More...
 
HtCapabilities m_htCapability
 HT capabilities. More...
 
SupportedRates m_rates
 List of supported rates. More...
 
Ssid m_ssid
 Service set ID (SSID) More...
 
uint64_t m_timestamp
 Timestamp. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 

Detailed Description

Implement the header for management frames of type probe response.

Doxygen introspection did not find any typical Config paths.


No Attributes are defined for this type.
No TraceSources are defined for this type.

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

Constructor & Destructor Documentation

ns3::MgtProbeResponseHeader::MgtProbeResponseHeader ( )

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

ns3::MgtProbeResponseHeader::~MgtProbeResponseHeader ( )

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

Member Function Documentation

uint32_t ns3::MgtProbeResponseHeader::Deserialize ( Buffer::Iterator  start)
virtual
Parameters
startan iterator which points to where the header should written.
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.

Implements ns3::Header.

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

References ns3::CapabilityInformation::Deserialize(), ns3::WifiInformationElement::Deserialize(), ns3::WifiInformationElement::DeserializeIfPresent(), ns3::SupportedRates::extended, ns3::Buffer::Iterator::GetDistanceFrom(), m_beaconInterval, m_capability, m_htCapability, m_rates, m_ssid, m_timestamp, ns3::Buffer::Iterator::ReadLsbtohU16(), ns3::Buffer::Iterator::ReadLsbtohU64(), and visualizer.core::start().

+ Here is the call graph for this function:

uint64_t ns3::MgtProbeResponseHeader::GetBeaconIntervalUs ( void  ) const

Return the beacon interval in microseconds unit.

Returns
beacon interval in microseconds unit

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

References m_beaconInterval.

Referenced by ns3::MeshWifiBeacon::GetBeaconInterval(), ns3::dot11s::PeerManagementProtocolMac::Receive(), and ns3::StaWifiMac::Receive().

+ Here is the caller graph for this function:

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

Return the HT capabilities.

Returns
HT capabilities

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

References m_htCapability.

TypeId ns3::MgtProbeResponseHeader::GetInstanceTypeId ( void  ) const
virtual
Returns
the TypeId associated to the most-derived type of this instance.

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

Implements ns3::ObjectBase.

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

References GetTypeId().

+ Here is the call graph for this function:

uint32_t ns3::MgtProbeResponseHeader::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 196 of file mgt-headers.cc.

References ns3::SupportedRates::extended, ns3::CapabilityInformation::GetSerializedSize(), ns3::ExtendedSupportedRatesIE::GetSerializedSize(), ns3::HtCapabilities::GetSerializedSize(), ns3::WifiInformationElement::GetSerializedSize(), m_capability, m_htCapability, m_rates, and m_ssid.

+ Here is the call graph for this function:

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

Return the Service Set Identifier (SSID).

Returns
SSID

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

References m_ssid.

Referenced by ns3::StaWifiMac::Receive(), and ns3::MeshWifiInterfaceMac::Receive().

+ Here is the caller graph for this function:

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

Return the supported rates.

Returns
the supported rates

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

References m_rates.

Referenced by ns3::StaWifiMac::Receive(), and ns3::MeshWifiInterfaceMac::Receive().

+ Here is the caller graph for this function:

uint64_t ns3::MgtProbeResponseHeader::GetTimestamp ( void  )

Return the time stamp.

Returns
time stamp

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

References m_timestamp.

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

Definition at line 182 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:

void ns3::MgtProbeResponseHeader::Print ( std::ostream &  os) const
virtual
Parameters
osoutput stream This method is used by Packet::Print to print the content of a trailer as ascii data to a c++ output stream. Although the trailer 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 211 of file mgt-headers.cc.

References m_htCapability, m_rates, and m_ssid.

void ns3::MgtProbeResponseHeader::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 218 of file mgt-headers.cc.

References ns3::SupportedRates::extended, m_beaconInterval, m_capability, m_htCapability, m_rates, m_ssid, ns3::Simulator::Now(), ns3::ExtendedSupportedRatesIE::Serialize(), ns3::CapabilityInformation::Serialize(), ns3::HtCapabilities::Serialize(), ns3::WifiInformationElement::Serialize(), visualizer.core::start(), ns3::Buffer::Iterator::WriteHtolsbU16(), and ns3::Buffer::Iterator::WriteHtolsbU64().

+ Here is the call graph for this function:

void ns3::MgtProbeResponseHeader::SetBeaconIntervalUs ( uint64_t  us)

Set the beacon interval in microseconds unit.

Parameters
usbeacon interval in microseconds unit

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

References m_beaconInterval.

Referenced by ns3::MeshWifiBeacon::MeshWifiBeacon().

+ Here is the caller graph for this function:

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

Set the HT capabilities.

Parameters
htcapabilitiesHT capabilities

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

References m_htCapability.

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

Set the Service Set Identifier (SSID).

Parameters
ssidSSID

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

References m_ssid.

Referenced by ns3::MeshWifiBeacon::MeshWifiBeacon(), ns3::ApWifiMac::SendOneBeacon(), and ns3::ApWifiMac::SendProbeResp().

+ Here is the caller graph for this function:

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

Set the supported rates.

Parameters
ratesthe supported rates

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

References m_rates.

Referenced by ns3::MeshWifiBeacon::MeshWifiBeacon().

+ Here is the caller graph for this function:

Member Data Documentation

uint64_t ns3::MgtProbeResponseHeader::m_beaconInterval
private

Beacon interval.

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

Referenced by Deserialize(), GetBeaconIntervalUs(), Serialize(), and SetBeaconIntervalUs().

CapabilityInformation ns3::MgtProbeResponseHeader::m_capability
private

Capability information.

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

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

HtCapabilities ns3::MgtProbeResponseHeader::m_htCapability
private

HT capabilities.

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

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

SupportedRates ns3::MgtProbeResponseHeader::m_rates
private

List of supported rates.

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

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

Ssid ns3::MgtProbeResponseHeader::m_ssid
private

Service set ID (SSID)

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

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

uint64_t ns3::MgtProbeResponseHeader::m_timestamp
private

Timestamp.

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

Referenced by Deserialize(), and GetTimestamp().


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