/usr/include/ns3.27/ns3/ap-wifi-mac.h is in libns3-dev 3.27+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2006, 2009 INRIA
* Copyright (c) 2009 MIRKO BANCHI
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Authors: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
* Mirko Banchi <mk.banchi@gmail.com>
*/
#ifndef AP_WIFI_MAC_H
#define AP_WIFI_MAC_H
#include "regular-wifi-mac.h"
#include "capability-information.h"
#include "ht-operation.h"
#include "supported-rates.h"
#include "dsss-parameter-set.h"
#include "erp-information.h"
#include "edca-parameter-set.h"
#include "ns3/random-variable-stream.h"
namespace ns3 {
/**
* \brief Wi-Fi AP state machine
* \ingroup wifi
*
* Handle association, dis-association and authentication,
* of STAs within an infrastructure BSS.
*/
class ApWifiMac : public RegularWifiMac
{
public:
/**
* \brief Get the type ID.
* \return the object TypeId
*/
static TypeId GetTypeId (void);
ApWifiMac ();
virtual ~ApWifiMac ();
/**
* \param stationManager the station manager attached to this MAC.
*/
void SetWifiRemoteStationManager (const Ptr<WifiRemoteStationManager> stationManager);
/**
* \param linkUp the callback to invoke when the link becomes up.
*/
void SetLinkUpCallback (Callback<void> linkUp);
/**
* \param packet the packet to send.
* \param to the address to which the packet should be sent.
*
* The packet should be enqueued in a tx queue, and should be
* dequeued as soon as the channel access function determines that
* access is granted to this MAC.
*/
void Enqueue (Ptr<const Packet> packet, Mac48Address to);
/**
* \param packet the packet to send.
* \param to the address to which the packet should be sent.
* \param from the address from which the packet should be sent.
*
* The packet should be enqueued in a tx queue, and should be
* dequeued as soon as the channel access function determines that
* access is granted to this MAC. The extra parameter "from" allows
* this device to operate in a bridged mode, forwarding received
* frames without altering the source address.
*/
void Enqueue (Ptr<const Packet> packet, Mac48Address to, Mac48Address from);
bool SupportsSendFrom (void) const;
/**
* \param address the current address of this MAC layer.
*/
void SetAddress (Mac48Address address);
/**
* \param interval the interval between two beacon transmissions.
*/
void SetBeaconInterval (Time interval);
/**
* \return the interval between two beacon transmissions.
*/
Time GetBeaconInterval (void) const;
/**
* Start beacon transmission immediately.
*/
void StartBeaconing (void);
/**
* Determine whether short slot time should be enabled or not in the BSS.
* Typically, true is returned only when there is no non-erp stations associated
* to the AP, and that short slot time is supported by the AP and by all other
* ERP stations that are associated to the AP. Otherwise, false is returned.
*
* \returns whether short slot time should be enabled or not in the BSS.
*/
bool GetShortSlotTimeEnabled (void) const;
/**
* Determine whether short preamble should be enabled or not in the BSS.
* Typically, true is returned only when the AP and all associated
* stations support short PLCP preamble.
*
* \returns whether short preamble should be enabled or not in the BSS.
*/
bool GetShortPreambleEnabled (void) const;
/**
* Determine whether non-Greenfield HT stations are present or not.
*
* \returns whether non-Greenfield HT stations are present or not.
*/
bool IsNonGfHtStasPresent (void) const;
/**
* Determine the VHT operational channel width (in MHz).
*
* \returns the VHT operational channel width (in MHz).
*/
uint8_t GetVhtOperationalChannelWidth (void) const;
/**
* Assign a fixed random variable stream number to the random variables
* used by this model. Return the number of streams (possibly zero) that
* have been assigned.
*
* \param stream first stream index to use
*
* \return the number of stream indices assigned by this model
*/
int64_t AssignStreams (int64_t stream);
private:
void Receive (Ptr<Packet> packet, const WifiMacHeader *hdr);
/**
* The packet we sent was successfully received by the receiver
* (i.e. we received an ACK from the receiver). If the packet
* was an association response to the receiver, we record that
* the receiver is now associated with us.
*
* \param hdr the header of the packet that we successfully sent
*/
void TxOk (const WifiMacHeader &hdr);
/**
* The packet we sent was successfully received by the receiver
* (i.e. we did not receive an ACK from the receiver). If the packet
* was an association response to the receiver, we record that
* the receiver is not associated with us yet.
*
* \param hdr the header of the packet that we failed to sent
*/
void TxFailed (const WifiMacHeader &hdr);
/**
* This method is called to de-aggregate an A-MSDU and forward the
* constituent packets up the stack. We override the WifiMac version
* here because, as an AP, we also need to think about redistributing
* to other associated STAs.
*
* \param aggregatedPacket the Packet containing the A-MSDU.
* \param hdr a pointer to the MAC header for \c aggregatedPacket.
*/
void DeaggregateAmsduAndForward (Ptr<Packet> aggregatedPacket,
const WifiMacHeader *hdr);
/**
* Forward the packet down to DCF/EDCAF (enqueue the packet). This method
* is a wrapper for ForwardDown with traffic id.
*
* \param packet the packet we are forwarding to DCF/EDCAF
* \param from the address to be used for Address 3 field in the header
* \param to the address to be used for Address 1 field in the header
*/
void ForwardDown (Ptr<const Packet> packet, Mac48Address from, Mac48Address to);
/**
* Forward the packet down to DCF/EDCAF (enqueue the packet).
*
* \param packet the packet we are forwarding to DCF/EDCAF
* \param from the address to be used for Address 3 field in the header
* \param to the address to be used for Address 1 field in the header
* \param tid the traffic id for the packet
*/
void ForwardDown (Ptr<const Packet> packet, Mac48Address from, Mac48Address to, uint8_t tid);
/**
* Forward a probe response packet to the DCF. The standard is not clear on the correct
* queue for management frames if QoS is supported. We always use the DCF.
*
* \param to the address of the STA we are sending a probe response to
*/
void SendProbeResp (Mac48Address to);
/**
* Forward an association response packet to the DCF. The standard is not clear on the correct
* queue for management frames if QoS is supported. We always use the DCF.
*
* \param to the address of the STA we are sending an association response to
* \param success indicates whether the association was successful or not
*/
void SendAssocResp (Mac48Address to, bool success);
/**
* Forward a beacon packet to the beacon special DCF.
*/
void SendOneBeacon (void);
/**
* Return the Capability information of the current AP.
*
* \return the Capability information that we support
*/
CapabilityInformation GetCapabilities (void) const;
/**
* Return the ERP information of the current AP.
*
* \return the ERP information that we support
*/
ErpInformation GetErpInformation (void) const;
/**
* Return the EDCA Parameter Set of the current AP.
*
* \return the EDCA Parameter Set that we support
*/
EdcaParameterSet GetEdcaParameterSet (void) const;
/**
* Return the HT operation of the current AP.
*
* \return the HT operation that we support
*/
HtOperation GetHtOperation (void) const;
/**
* Return the VHT operation of the current AP.
*
* \return the VHT operation that we support
*/
VhtOperation GetVhtOperation (void) const;
/**
* Return an instance of SupportedRates that contains all rates that we support
* including HT rates.
*
* \return SupportedRates all rates that we support
*/
SupportedRates GetSupportedRates (void) const;
/**
* Return the DSSS Parameter Set that we support.
*
* \return the DSSS Parameter Set that we support
*/
DsssParameterSet GetDsssParameterSet (void) const;
/**
* Enable or disable beacon generation of the AP.
*
* \param enable enable or disable beacon generation
*/
void SetBeaconGeneration (bool enable);
/**
* Return whether the AP is generating beacons.
*
* \return true if beacons are periodically generated, false otherwise
*/
bool GetBeaconGeneration (void) const;
/**
* Return whether protection for non-ERP stations is used in the BSS.
*
* \return true if protection for non-ERP stations is used in the BSS,
* false otherwise
*/
bool GetUseNonErpProtection (void) const;
/**
* Return whether RIFS is allowed in the BSS.
*
* \return true if RIFS is allowed in the BSS,
* false otherwise
*/
bool GetRifsMode (void) const;
void DoDispose (void);
void DoInitialize (void);
Ptr<DcaTxop> m_beaconDca; //!< Dedicated DcaTxop for beacons
Time m_beaconInterval; //!< Interval between beacons
bool m_enableBeaconGeneration; //!< Flag whether beacons are being generated
EventId m_beaconEvent; //!< Event to generate one beacon
Ptr<UniformRandomVariable> m_beaconJitter; //!< UniformRandomVariable used to randomize the time of the first beacon
bool m_enableBeaconJitter; //!< Flag whether the first beacon should be generated at random time
std::list<Mac48Address> m_staList; //!< List of all stations currently associated to the AP
std::list<Mac48Address> m_nonErpStations; //!< List of all non-ERP stations currently associated to the AP
std::list<Mac48Address> m_nonHtStations; //!< List of all non-HT stations currently associated to the AP
bool m_enableNonErpProtection; //!< Flag whether protection mechanism is used or not when non-ERP STAs are present within the BSS
bool m_disableRifs; //!< Flag whether to force RIFS to be disabled within the BSS If non-HT STAs are detected
};
} //namespace ns3
#endif /* AP_WIFI_MAC_H */
|