A Discrete-Event Network Simulator
API
wifi-remote-station-manager.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2005,2006,2007 INRIA
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation;
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 *
17 * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
18 */
19
20#ifndef WIFI_REMOTE_STATION_MANAGER_H
21#define WIFI_REMOTE_STATION_MANAGER_H
22
23#include "qos-utils.h"
24#include "wifi-mode.h"
26#include "wifi-utils.h"
27
28#include "ns3/data-rate.h"
29#include "ns3/eht-capabilities.h"
30#include "ns3/he-capabilities.h"
31#include "ns3/ht-capabilities.h"
32#include "ns3/mac48-address.h"
33#include "ns3/object.h"
34#include "ns3/traced-callback.h"
35#include "ns3/vht-capabilities.h"
36
37#include <array>
38#include <memory>
39#include <optional>
40#include <unordered_map>
41
42namespace ns3
43{
44
45class WifiPhy;
46class WifiMac;
47class WifiMacHeader;
48class Packet;
49class WifiMpdu;
50class WifiTxVector;
51
52struct WifiRemoteStationState;
53struct RxSignalInfo;
54
67{
68 virtual ~WifiRemoteStation(){};
70 std::pair<double, Time>
73};
74
79{
83 enum
84 {
91
104 uint16_t m_aid;
106 std::optional<Mac48Address> m_mldAddress;
116
117 uint16_t m_channelWidth;
120 uint8_t m_ness;
125};
126
134{
135 public:
140 static TypeId GetTypeId();
141
143 ~WifiRemoteStationManager() override;
144
147 {
150 };
151
155 using Stations = std::unordered_map<Mac48Address, WifiRemoteStation*, WifiAddressHash>;
160 std::unordered_map<Mac48Address, std::shared_ptr<WifiRemoteStationState>, WifiAddressHash>;
161
168 virtual void SetupPhy(const Ptr<WifiPhy> phy);
175 virtual void SetupMac(const Ptr<WifiMac> mac);
176
185 virtual int64_t AssignStreams(int64_t stream);
186
192 void SetMaxSsrc(uint32_t maxSsrc);
198 void SetMaxSlrc(uint32_t maxSlrc);
204 void SetRtsCtsThreshold(uint32_t threshold);
205
218 void SetFragmentationThreshold(uint32_t threshold);
219
226 void SetAssociationId(Mac48Address remoteAddress, uint16_t aid);
233 void SetQosSupport(Mac48Address from, bool qosSupported);
240 void AddStationHtCapabilities(Mac48Address from, HtCapabilities htCapabilities);
247 void AddStationVhtCapabilities(Mac48Address from, VhtCapabilities vhtCapabilities);
254 void AddStationHeCapabilities(Mac48Address from, HeCapabilities heCapabilities);
261 void AddStationEhtCapabilities(Mac48Address from, EhtCapabilities ehtCapabilities);
295 bool GetHtSupported() const;
301 bool GetVhtSupported() const;
307 bool GetHeSupported() const;
313 bool GetEhtSupported() const;
319 bool GetLdpcSupported() const;
331 uint16_t GetGuardInterval() const;
337 void SetUseNonErpProtection(bool enable);
344 bool GetUseNonErpProtection() const;
350 void SetUseNonHtProtection(bool enable);
357 bool GetUseNonHtProtection() const;
363 void SetShortPreambleEnabled(bool enable);
370 bool GetShortPreambleEnabled() const;
376 void SetShortSlotTimeEnabled(bool enable);
383 bool GetShortSlotTimeEnabled() const;
384
388 void Reset();
389
397 void AddBasicMode(WifiMode mode);
403 WifiMode GetDefaultMode() const;
409 uint8_t GetNBasicModes() const;
417 WifiMode GetBasicMode(uint8_t i) const;
431 WifiMode GetNonErpBasicMode(uint8_t i) const;
474 uint16_t GetAssociationId(Mac48Address remoteAddress) const;
481 void AddBasicMcs(WifiMode mcs);
487 WifiMode GetDefaultMcs() const;
500 uint8_t GetNBasicMcs() const;
508 WifiMode GetBasicMcs(uint8_t i) const;
557 bool GetDsssSupported(const Mac48Address& address) const;
566 bool GetErpOfdmSupported(const Mac48Address& address) const;
575 bool GetOfdmSupported(const Mac48Address& address) const;
612
619
658 void AddSupportedPhyPreamble(Mac48Address address, bool isShortPreambleSupported);
666 void AddSupportedErpSlotTime(Mac48Address address, bool isShortSlotTimeSupported);
675 bool IsBrandNew(Mac48Address address) const;
735
743 void SetMldAddress(const Mac48Address& address, const Mac48Address& mldAddress);
753 std::optional<Mac48Address> GetMldAddress(const Mac48Address& address) const;
762 std::optional<Mac48Address> GetAffiliatedStaAddress(const Mac48Address& mldAddress) const;
763
769 WifiTxVector GetDataTxVector(const WifiMacHeader& header, uint16_t allowedWidth);
802 WifiTxVector GetAckTxVector(Mac48Address to, const WifiTxVector& dataTxVector) const;
811 WifiTxVector GetBlockAckTxVector(Mac48Address to, const WifiTxVector& dataTxVector) const;
819
826 void ReportRtsFailed(const WifiMacHeader& header);
844 void ReportRtsOk(const WifiMacHeader& header, double ctsSnr, WifiMode ctsMode, double rtsSnr);
856 double ackSnr,
857 WifiMode ackMode,
858 double dataSnr,
859 WifiTxVector dataTxVector);
866 void ReportFinalRtsFailed(const WifiMacHeader& header);
887 uint16_t nSuccessfulMpdus,
888 uint16_t nFailedMpdus,
889 double rxSnr,
890 double dataSnr,
891 WifiTxVector dataTxVector);
892
900 void ReportRxOk(Mac48Address address, RxSignalInfo rxSignalInfo, WifiTxVector txVector);
901
909 bool NeedRts(const WifiMacHeader& header, uint32_t size);
918 bool NeedCtsToSelf(WifiTxVector txVector);
919
954 bool IsLastFragment(Ptr<const WifiMpdu> mpdu, uint32_t fragmentNumber);
955
959 uint8_t GetDefaultTxPowerLevel() const;
982 void SetDefaultTxPowerLevel(uint8_t txPower);
986 uint8_t GetNumberOfAntennas() const;
990 uint8_t GetMaxNumberOfTransmitStreams() const;
998 bool UseLdpcForDestination(Mac48Address dest) const;
999
1007 typedef void (*PowerChangeTracedCallback)(double oldPower,
1008 double newPower,
1009 Mac48Address remoteAddress);
1010
1018 typedef void (*RateChangeTracedCallback)(DataRate oldRate,
1019 DataRate newRate,
1020 Mac48Address remoteAddress);
1021
1027 Ptr<WifiPhy> GetPhy() const;
1033 Ptr<WifiMac> GetMac() const;
1034
1035 protected:
1036 void DoDispose() override;
1045 WifiMode GetSupported(const WifiRemoteStation* station, uint8_t i) const;
1053 uint8_t GetNSupported(const WifiRemoteStation* station) const;
1062 bool GetQosSupported(const WifiRemoteStation* station) const;
1071 bool GetHtSupported(const WifiRemoteStation* station) const;
1080 bool GetVhtSupported(const WifiRemoteStation* station) const;
1089 bool GetHeSupported(const WifiRemoteStation* station) const;
1098 bool GetEhtSupported(const WifiRemoteStation* station) const;
1108 WifiMode GetMcsSupported(const WifiRemoteStation* station, uint8_t i) const;
1116 uint8_t GetNMcsSupported(const WifiRemoteStation* station) const;
1125 WifiMode GetNonErpSupported(const WifiRemoteStation* station, uint8_t i) const;
1133 uint32_t GetNNonErpSupported(const WifiRemoteStation* station) const;
1141 Mac48Address GetAddress(const WifiRemoteStation* station) const;
1149 uint16_t GetChannelWidth(const WifiRemoteStation* station) const;
1158 bool GetShortGuardIntervalSupported(const WifiRemoteStation* station) const;
1166 uint16_t GetGuardInterval(const WifiRemoteStation* station) const;
1175 bool GetAggregation(const WifiRemoteStation* station) const;
1176
1184 uint8_t GetNumberOfSupportedStreams(const WifiRemoteStation* station) const;
1192 uint8_t GetNess(const WifiRemoteStation* station) const;
1193
1194 private:
1204 uint16_t GetStaId(Mac48Address address, const WifiTxVector& txVector) const;
1205
1217 virtual bool DoNeedRts(WifiRemoteStation* station, uint32_t size, bool normally);
1229 virtual bool DoNeedRetransmission(WifiRemoteStation* station,
1230 Ptr<const Packet> packet,
1231 bool normally);
1243 virtual bool DoNeedFragmentation(WifiRemoteStation* station,
1244 Ptr<const Packet> packet,
1245 bool normally);
1258 virtual WifiTxVector DoGetDataTxVector(WifiRemoteStation* station, uint16_t allowedWidth) = 0;
1268
1275 virtual void DoReportRtsFailed(WifiRemoteStation* station) = 0;
1282 virtual void DoReportDataFailed(WifiRemoteStation* station) = 0;
1292 virtual void DoReportRtsOk(WifiRemoteStation* station,
1293 double ctsSnr,
1294 WifiMode ctsMode,
1295 double rtsSnr) = 0;
1307 virtual void DoReportDataOk(WifiRemoteStation* station,
1308 double ackSnr,
1309 WifiMode ackMode,
1310 double dataSnr,
1311 uint16_t dataChannelWidth,
1312 uint8_t dataNss) = 0;
1319 virtual void DoReportFinalRtsFailed(WifiRemoteStation* station) = 0;
1326 virtual void DoReportFinalDataFailed(WifiRemoteStation* station) = 0;
1335 virtual void DoReportRxOk(WifiRemoteStation* station, double rxSnr, WifiMode txMode) = 0;
1351 virtual void DoReportAmpduTxStatus(WifiRemoteStation* station,
1352 uint16_t nSuccessfulMpdus,
1353 uint16_t nFailedMpdus,
1354 double rxSnr,
1355 double dataSnr,
1356 uint16_t dataChannelWidth,
1357 uint8_t dataNss);
1358
1365 std::shared_ptr<WifiRemoteStationState> LookupState(Mac48Address address) const;
1374
1381 void DoSetFragmentationThreshold(uint32_t threshold);
1396
1414
1425
1428
1431
1448
1449 std::array<uint32_t, AC_BE_NQOS> m_ssrc;
1450 std::array<uint32_t, AC_BE_NQOS> m_slrc;
1451
1470};
1471
1472} // namespace ns3
1473
1474#endif /* WIFI_REMOTE_STATION_MANAGER_H */
Class for representing data rates.
Definition: data-rate.h:90
The IEEE 802.11be EHT Capabilities.
The IEEE 802.11ax HE Capabilities.
The HT Capabilities Information Element.
an EUI-48 address
Definition: mac48-address.h:46
A base class which provides memory management and object aggregation.
Definition: object.h:89
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:78
Forward calls to a chain of Callback.
a unique identifier for an interface.
Definition: type-id.h:60
The IEEE 802.11ac VHT Capabilities.
Implements the IEEE 802.11 MAC header.
represent a single transmission mode
Definition: wifi-mode.h:50
TID independent remote station statistics.
hold a list of per-remote-station state.
void ReportDataFailed(Ptr< const WifiMpdu > mpdu)
Should be invoked whenever the AckTimeout associated to a transmission attempt expires.
bool GetQosSupported(Mac48Address address) const
Return whether the given station is QoS capable.
uint8_t GetNumberOfSupportedStreams(Mac48Address address) const
Return the number of spatial streams supported by the station.
WifiTxVector GetAckTxVector(Mac48Address to, const WifiTxVector &dataTxVector) const
Return a TXVECTOR for the Ack frame given the destination and the mode of the Data used by the sender...
virtual bool DoNeedFragmentation(WifiRemoteStation *station, Ptr< const Packet > packet, bool normally)
uint32_t m_fragmentationThreshold
Current threshold for fragmentation.
void SetShortSlotTimeEnabled(bool enable)
Enable or disable short slot time.
uint8_t GetNess(const WifiRemoteStation *station) const
void AddBasicMode(WifiMode mode)
Invoked in a STA upon association to store the set of rates which belong to the BSSBasicRateSet of th...
virtual int64_t AssignStreams(int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model.
uint32_t GetNFragments(Ptr< const WifiMpdu > mpdu)
Return the number of fragments needed for the given packet.
uint16_t GetAssociationId(Mac48Address remoteAddress) const
Get the AID of a remote station.
WifiMode m_defaultTxMcs
The default transmission modulation-coding scheme (MCS)
ProtectionMode m_htProtectionMode
Protection mode for HT stations when non-HT stations are detected.
WifiMode GetDefaultModeForSta(const WifiRemoteStation *st) const
Return the default MCS to use to transmit frames to the given station.
std::array< uint32_t, AC_BE_NQOS > m_slrc
long retry count per AC
WifiRemoteStation * Lookup(Mac48Address address) const
Return the station associated with the given address.
uint32_t GetFragmentationThreshold() const
Return the fragmentation threshold.
bool NeedRetransmission(Ptr< const WifiMpdu > mpdu)
uint8_t GetNBasicModes() const
Return the number of basic modes we support.
bool UseLdpcForDestination(Mac48Address dest) const
uint32_t m_maxSsrc
Maximum STA short retry count (SSRC)
void SetRtsCtsThreshold(uint32_t threshold)
Sets the RTS threshold.
void AddAllSupportedMcs(Mac48Address address)
Invoked in a STA or AP to store all of the MCS supported by a destination which is also supported loc...
TracedCallback< Mac48Address > m_macTxRtsFailed
The trace source fired when the transmission of a single RTS has failed.
virtual bool DoNeedRts(WifiRemoteStation *station, uint32_t size, bool normally)
uint16_t GetChannelWidth(const WifiRemoteStation *station) const
Return the channel width supported by the station.
void DoSetFragmentationThreshold(uint32_t threshold)
Actually sets the fragmentation threshold, it also checks the validity of the given threshold.
bool IsBrandNew(Mac48Address address) const
Return whether the station state is brand new.
virtual void DoReportFinalDataFailed(WifiRemoteStation *station)=0
This method is a pure virtual method that must be implemented by the sub-class.
virtual void DoReportRtsOk(WifiRemoteStation *station, double ctsSnr, WifiMode ctsMode, double rtsSnr)=0
This method is a pure virtual method that must be implemented by the sub-class.
bool GetShortSlotTimeEnabled() const
Return whether the device uses short slot time.
void DoDispose() override
Destructor implementation.
virtual void DoReportDataFailed(WifiRemoteStation *station)=0
This method is a pure virtual method that must be implemented by the sub-class.
bool NeedRts(const WifiMacHeader &header, uint32_t size)
bool IsLastFragment(Ptr< const WifiMpdu > mpdu, uint32_t fragmentNumber)
void ReportFinalDataFailed(Ptr< const WifiMpdu > mpdu)
Should be invoked after calling ReportDataFailed if NeedRetransmission returns false.
uint32_t GetNNonErpBasicModes() const
Return the number of non-ERP basic modes we support.
void SetUseNonErpProtection(bool enable)
Enable or disable protection for non-ERP stations.
uint8_t GetNSupported(const WifiRemoteStation *station) const
Return the number of modes supported by the given station.
bool m_useNonHtProtection
flag if protection for non-HT stations against HT transmissions is enabled
bool GetShortPreambleSupported(Mac48Address address) const
Return whether the station supports short PHY preamble or not.
void(* PowerChangeTracedCallback)(double oldPower, double newPower, Mac48Address remoteAddress)
TracedCallback signature for power change events.
void AddAllSupportedModes(Mac48Address address)
Invoked in a STA or AP to store all of the modes supported by a destination which is also supported l...
std::optional< Mac48Address > GetAffiliatedStaAddress(const Mac48Address &mldAddress) const
Get the address of the remote station operating on this link and affiliated with the MLD having the g...
WifiMode GetNonErpBasicMode(uint8_t i) const
Return a basic mode from the set of basic modes that is not an ERP mode.
void ReportRtsOk(const WifiMacHeader &header, double ctsSnr, WifiMode ctsMode, double rtsSnr)
Should be invoked whenever we receive the CTS associated to an RTS we just sent.
Ptr< WifiPhy > GetPhy() const
Return the WifiPhy.
void AddSupportedMcs(Mac48Address address, WifiMode mcs)
Record the MCS index supported by the station.
WifiTxVector GetBlockAckTxVector(Mac48Address to, const WifiTxVector &dataTxVector) const
Return a TXVECTOR for the BlockAck frame given the destination and the mode of the Data used by the s...
void RemoveAllSupportedMcs(Mac48Address address)
Invoked in a STA or AP to delete all of the supported MCS by a destination.
uint32_t DoGetFragmentationThreshold() const
Return the current fragmentation threshold.
WifiModeList m_bssBasicMcsSet
basic MCS set
TracedCallback< Mac48Address > m_macTxFinalRtsFailed
The trace source fired when the transmission of a RTS has exceeded the maximum number of attempts.
WifiMode GetNonUnicastMode() const
Return a mode for non-unicast packets.
bool m_shortPreambleEnabled
flag if short PHY preamble is enabled
void AddStationVhtCapabilities(Mac48Address from, VhtCapabilities vhtCapabilities)
Records VHT capabilities of the remote station.
bool GetShortSlotTimeSupported(Mac48Address address) const
Return whether the station supports short ERP slot time or not.
void SetShortPreambleEnabled(bool enable)
Enable or disable short PHY preambles.
virtual WifiTxVector DoGetDataTxVector(WifiRemoteStation *station, uint16_t allowedWidth)=0
WifiMode GetDefaultMcs() const
Return the default Modulation and Coding Scheme (MCS) index.
Ptr< WifiPhy > m_wifiPhy
This is a pointer to the WifiPhy associated with this WifiRemoteStationManager that is set on call to...
void AddBasicMcs(WifiMode mcs)
Add a given Modulation and Coding Scheme (MCS) index to the set of basic MCS.
void ReportRxOk(Mac48Address address, RxSignalInfo rxSignalInfo, WifiTxVector txVector)
uint8_t m_defaultTxPowerLevel
Default transmission power level.
bool GetErpOfdmSupported(const Mac48Address &address) const
Return whether the station supports ERP OFDM or not.
static TypeId GetTypeId()
Get the type ID.
WifiMode m_nonUnicastMode
Transmission mode for non-unicast Data frames.
void SetUseNonHtProtection(bool enable)
Enable or disable protection for non-HT stations.
uint16_t GetGuardInterval() const
Return the supported HE guard interval duration (in nanoseconds).
bool IsAssociated(Mac48Address address) const
Return whether the station associated.
Ptr< const HtCapabilities > GetStationHtCapabilities(Mac48Address from)
Return the HT capabilities sent by the remote station.
bool NeedFragmentation(Ptr< const WifiMpdu > mpdu)
void ReportAmpduTxStatus(Mac48Address address, uint16_t nSuccessfulMpdus, uint16_t nFailedMpdus, double rxSnr, double dataSnr, WifiTxVector dataTxVector)
Typically called per A-MPDU, either when a Block ACK was successfully received or when a BlockAckTime...
bool GetDsssSupported(const Mac48Address &address) const
Return whether the station supports DSSS or not.
uint32_t GetFragmentOffset(Ptr< const WifiMpdu > mpdu, uint32_t fragmentNumber)
double GetMostRecentRssi(Mac48Address address) const
void SetQosSupport(Mac48Address from, bool qosSupported)
Records QoS support of the remote station.
WifiRemoteStationInfo GetInfo(Mac48Address address)
bool GetOfdmSupported(const Mac48Address &address) const
Return whether the station supports OFDM or not.
void(* RateChangeTracedCallback)(DataRate oldRate, DataRate newRate, Mac48Address remoteAddress)
TracedCallback signature for rate change events.
uint32_t GetFragmentSize(Ptr< const WifiMpdu > mpdu, uint32_t fragmentNumber)
WifiTxVector GetCtsToSelfTxVector()
Since CTS-to-self parameters are not dependent on the station, it is implemented in wifi remote stati...
uint8_t GetNBasicMcs() const
Return the number of basic MCS index.
bool GetAggregation(const WifiRemoteStation *station) const
Return whether the given station supports A-MPDU.
bool GetHtSupported() const
Return whether the device has HT capability support enabled.
void RecordWaitAssocTxOk(Mac48Address address)
Records that we are waiting for an ACK for the association response we sent.
void SetFragmentationThreshold(uint32_t threshold)
Sets a fragmentation threshold.
Ptr< WifiMac > m_wifiMac
This is a pointer to the WifiMac associated with this WifiRemoteStationManager that is set on call to...
void SetMldAddress(const Mac48Address &address, const Mac48Address &mldAddress)
Set the address of the MLD the given station is affiliated with.
void RecordGotAssocTxOk(Mac48Address address)
Records that we got an ACK for the association response we sent.
bool GetLdpcSupported() const
Return whether the device has LDPC support enabled.
std::unordered_map< Mac48Address, std::shared_ptr< WifiRemoteStationState >, WifiAddressHash > StationStates
A map of WifiRemoteStationStates with Mac48Address as key.
void AddStationHeCapabilities(Mac48Address from, HeCapabilities heCapabilities)
Records HE capabilities of the remote station.
bool GetEhtSupported() const
Return whether the device has EHT capability support enabled.
void AddSupportedMode(Mac48Address address, WifiMode mode)
Invoked in a STA or AP to store the set of modes supported by a destination which is also supported l...
std::shared_ptr< WifiRemoteStationState > LookupState(Mac48Address address) const
Return the state of the station associated with the given address.
Ptr< WifiMac > GetMac() const
Return the WifiMac.
WifiMode GetNonErpSupported(const WifiRemoteStation *station, uint8_t i) const
Return whether non-ERP mode associated with the specified station at the specified index.
std::array< uint32_t, AC_BE_NQOS > m_ssrc
short retry count per AC
Ptr< const EhtCapabilities > GetStationEhtCapabilities(Mac48Address from)
Return the EHT capabilities sent by the remote station.
void RecordAssocRefused(Mac48Address address)
Records that association request was refused.
void ReportFinalRtsFailed(const WifiMacHeader &header)
Should be invoked after calling ReportRtsFailed if NeedRetransmission returns false.
StationStates m_states
States of known stations.
bool NeedCtsToSelf(WifiTxVector txVector)
Return if we need to do CTS-to-self before sending a DATA.
std::unordered_map< Mac48Address, WifiRemoteStation *, WifiAddressHash > Stations
A map of WifiRemoteStations with Mac48Address as key.
WifiTxVector GetCtsTxVector(Mac48Address to, WifiMode rtsTxMode) const
Return a TXVECTOR for the CTS frame given the destination and the mode of the RTS used by the sender.
void SetMaxSsrc(uint32_t maxSsrc)
Sets the maximum STA short retry count (SSRC).
Ptr< const HeCapabilities > GetStationHeCapabilities(Mac48Address from)
Return the HE capabilities sent by the remote station.
WifiMode GetBasicMcs(uint8_t i) const
Return the MCS at the given list index.
uint8_t GetNMcsSupported(Mac48Address address) const
Return the number of MCS supported by the station.
TracedCallback< Mac48Address > m_macTxDataFailed
The trace source fired when the transmission of a single data packet has failed.
uint16_t GetStaId(Mac48Address address, const WifiTxVector &txVector) const
If the given TXVECTOR is used for a MU transmission, return the STAID of the station with the given a...
WifiMode GetBasicMode(uint8_t i) const
Return a basic mode from the set of basic modes.
void AddStationEhtCapabilities(Mac48Address from, EhtCapabilities ehtCapabilities)
Records EHT capabilities of the remote station.
void AddSupportedPhyPreamble(Mac48Address address, bool isShortPreambleSupported)
Record whether the short PHY preamble is supported by the station.
bool GetShortGuardIntervalSupported() const
Return whether the device has SGI support enabled.
Mac48Address GetAddress(const WifiRemoteStation *station) const
Return the address of the station.
virtual void SetupPhy(const Ptr< WifiPhy > phy)
Set up PHY associated with this device since it is the object that knows the full set of transmit rat...
virtual void DoReportRtsFailed(WifiRemoteStation *station)=0
This method is a pure virtual method that must be implemented by the sub-class.
void SetDefaultTxPowerLevel(uint8_t txPower)
Set the default transmission power level.
void RecordDisassociated(Mac48Address address)
Records that the STA was disassociated.
Stations m_stations
Information for each known stations.
virtual WifiTxVector DoGetRtsTxVector(WifiRemoteStation *station)=0
WifiMode GetMcsSupported(const WifiRemoteStation *station, uint8_t i) const
Return the WifiMode supported by the specified station at the specified index.
uint32_t GetNNonErpSupported(const WifiRemoteStation *station) const
Return the number of non-ERP modes supported by the given station.
uint16_t GetChannelWidthSupported(Mac48Address address) const
Return the channel width supported by the station.
uint32_t m_maxSlrc
Maximum STA long retry count (SLRC)
virtual WifiRemoteStation * DoCreateStation() const =0
void Reset()
Reset the station, invoked in a STA upon dis-association or in an AP upon reboot.
bool GetUseNonErpProtection() const
Return whether the device supports protection of non-ERP stations.
bool IsAssocRefused(Mac48Address address) const
Return whether we refused an association request from the given station.
void SetAssociationId(Mac48Address remoteAddress, uint16_t aid)
Record the AID of a remote station.
virtual void DoReportAmpduTxStatus(WifiRemoteStation *station, uint16_t nSuccessfulMpdus, uint16_t nFailedMpdus, double rxSnr, double dataSnr, uint16_t dataChannelWidth, uint8_t dataNss)
Typically called per A-MPDU, either when a Block ACK was successfully received or when a BlockAckTime...
bool GetVhtSupported() const
Return whether the device has VHT capability support enabled.
Ptr< const VhtCapabilities > GetStationVhtCapabilities(Mac48Address from)
Return the VHT capabilities sent by the remote station.
ProtectionMode m_erpProtectionMode
Protection mode for ERP stations when non-ERP stations are detected.
WifiModeList m_bssBasicRateSet
This member is the list of WifiMode objects that comprise the BSSBasicRateSet parameter.
virtual void DoReportDataOk(WifiRemoteStation *station, double ackSnr, WifiMode ackMode, double dataSnr, uint16_t dataChannelWidth, uint8_t dataNss)=0
This method is a pure virtual method that must be implemented by the sub-class.
ProtectionMode
ProtectionMode enumeration.
WifiTxVector GetDataTxVector(const WifiMacHeader &header, uint16_t allowedWidth)
void ReportDataOk(Ptr< const WifiMpdu > mpdu, double ackSnr, WifiMode ackMode, double dataSnr, WifiTxVector dataTxVector)
Should be invoked whenever we receive the ACK associated to a data packet we just sent.
void ReportRtsFailed(const WifiMacHeader &header)
Should be invoked whenever the RtsTimeout associated to a transmission attempt expires.
void AddSupportedErpSlotTime(Mac48Address address, bool isShortSlotTimeSupported)
Record whether the short ERP slot time is supported by the station.
bool GetShortPreambleEnabled() const
Return whether the device uses short PHY preambles.
WifiMode GetSupported(const WifiRemoteStation *station, uint8_t i) const
Return whether mode associated with the specified station at the specified index.
bool GetHeSupported() const
Return whether the device has HE capability support enabled.
WifiMode m_defaultTxMode
The default transmission mode.
virtual void DoReportRxOk(WifiRemoteStation *station, double rxSnr, WifiMode txMode)=0
This method is a pure virtual method that must be implemented by the sub-class.
void AddStationHtCapabilities(Mac48Address from, HtCapabilities htCapabilities)
Records HT capabilities of the remote station.
virtual bool DoNeedRetransmission(WifiRemoteStation *station, Ptr< const Packet > packet, bool normally)
WifiMode GetDefaultMode() const
Return the default transmission mode.
void RecordGotAssocTxFailed(Mac48Address address)
Records that we missed an ACK for the association response we sent.
std::optional< Mac48Address > GetMldAddress(const Mac48Address &address) const
Get the address of the MLD the given station is affiliated with, if any.
virtual void DoReportFinalRtsFailed(WifiRemoteStation *station)=0
This method is a pure virtual method that must be implemented by the sub-class.
virtual void SetupMac(const Ptr< WifiMac > mac)
Set up MAC associated with this device since it is the object that knows the full set of timing param...
WifiTxVector GetRtsTxVector(Mac48Address address)
uint32_t m_rtsCtsThreshold
Threshold for RTS/CTS.
bool m_useNonErpProtection
flag if protection for non-ERP stations against ERP transmissions is enabled
WifiMode GetControlAnswerMode(WifiMode reqMode) const
Get control answer mode function.
bool m_shortSlotTimeEnabled
flag if short slot time is enabled
bool IsWaitAssocTxOk(Mac48Address address) const
Return whether we are waiting for an ACK for the association response we sent.
void SetMaxSlrc(uint32_t maxSlrc)
Sets the maximum STA long retry count (SLRC).
TracedCallback< Mac48Address > m_macTxFinalDataFailed
The trace source fired when the transmission of a data packet has exceeded the maximum number of atte...
bool GetUseNonHtProtection() const
Return whether the device supports protection of non-HT stations.
This class mimics the TXVECTOR which is to be passed to the PHY in order to define the parameters whi...
address
Definition: first.py:40
Every class exported by the ns3 library is enclosed in the ns3 namespace.
std::vector< WifiMode > WifiModeList
In various parts of the code, folk are interested in maintaining a list of transmission modes.
Definition: wifi-mode.h:261
mac
Definition: third.py:85
phy
Definition: third.py:82
RxSignalInfo structure containing info on the received signal.
Definition: phy-entity.h:70
Function object to compute the hash of a MAC address.
Definition: qos-utils.h:57
hold per-remote-station state.
WifiRemoteStationState * m_state
Remote station state.
std::pair< double, Time > m_rssiAndUpdateTimePair
RSSI (in dBm) of the most recent packet received from the remote station along with update time.
A struct that holds information about each remote station.
Mac48Address m_address
Mac48Address of the remote station.
bool m_shortSlotTime
Flag if short ERP slot time is supported by the remote station.
bool m_dsssSupported
Flag if DSSS is supported by the remote station.
uint16_t m_channelWidth
Channel width (in MHz) supported by the remote station.
std::optional< Mac48Address > m_mldAddress
MLD MAC address if the remote station is affiliated with an MLD.
uint16_t m_aid
AID of the remote station (unused if this object is installed on a non-AP station)
bool m_ofdmSupported
Flag if OFDM is supported by the remote station.
enum ns3::WifiRemoteStationState::@78 m_state
State of the station.
uint8_t m_ness
Number of extended spatial streams of the remote station.
bool m_aggregation
Flag if MPDU aggregation is used by the remote station.
bool m_qosSupported
Flag if QoS is supported by the station.
WifiModeList m_operationalRateSet
This member is the list of WifiMode objects that comprise the OperationalRateSet parameter for this r...
WifiModeList m_operationalMcsSet
operational MCS set
uint16_t m_guardInterval
HE Guard interval duration (in nanoseconds) supported by the remote station.
Ptr< const EhtCapabilities > m_ehtCapabilities
remote station EHT capabilities
bool m_shortPreamble
Flag if short PHY preamble is supported by the remote station.
bool m_erpOfdmSupported
Flag if ERP OFDM is supported by the remote station.
Ptr< const VhtCapabilities > m_vhtCapabilities
remote station VHT capabilities
WifiRemoteStationInfo m_info
remote station info
Ptr< const HtCapabilities > m_htCapabilities
remote station HT capabilities
Ptr< const HeCapabilities > m_heCapabilities
remote station HE capabilities