A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
ns3::ApWifiMac Class Reference
Wifi Models

Wi-Fi AP state machineHandle association, dis-association and authentication, of STAs within an infrastructure BSS. More...

#include <ap-wifi-mac.h>

+ Inheritance diagram for ns3::ApWifiMac:
+ Collaboration diagram for ns3::ApWifiMac:

Public Member Functions

 ApWifiMac ()
 
virtual ~ApWifiMac ()
 
int64_t AssignStreams (int64_t stream)
 Assign a fixed random variable stream number to the random variables used by this model. More...
 
virtual void Enqueue (Ptr< const Packet > packet, Mac48Address to)
 
virtual void Enqueue (Ptr< const Packet > packet, Mac48Address to, Mac48Address from)
 
Time GetBeaconInterval (void) const
 
virtual void SetAddress (Mac48Address address)
 
void SetBeaconInterval (Time interval)
 
virtual void SetLinkUpCallback (Callback< void > linkUp)
 
virtual void SetWifiRemoteStationManager (Ptr< WifiRemoteStationManager > stationManager)
 
void StartBeaconing (void)
 Start beacon transmission immediately. More...
 
virtual bool SupportsSendFrom (void) const
 
- Public Member Functions inherited from ns3::RegularWifiMac
 RegularWifiMac ()
 
virtual ~RegularWifiMac ()
 
Time GetAckTimeout (void) const
 
virtual Mac48Address GetAddress (void) const
 
virtual Time GetBasicBlockAckTimeout (void) const
 
virtual Mac48Address GetBssid (void) const
 
virtual Time GetCompressedBlockAckTimeout (void) const
 
Time GetCtsTimeout (void) const
 
bool GetCtsToSelfSupported () const
 Return whether the device supports CTS-to-self capability. More...
 
Time GetEifsNoDifs (void) const
 
Time GetPifs (void) const
 
Time GetRifs (void) const
 
Time GetSifs (void) const
 
Time GetSlot (void) const
 
virtual Ssid GetSsid (void) const
 
virtual Ptr< WifiPhy > GetWifiPhy () const
 
virtual Ptr
< WifiRemoteStationManager > 		GetWifiRemoteStationManager () const
 
void SetAckTimeout (Time ackTimeout)
 
virtual void SetBasicBlockAckTimeout (Time blockAckTimeout)
 
virtual void SetBssid (Mac48Address bssid)
 
virtual void SetCompressedBlockAckTimeout (Time blockAckTimeout)
 
void SetCtsTimeout (Time ctsTimeout)
 
void SetCtsToSelfSupported (bool enable)
 Enable or disable CTS-to-self feature. More...
 
void SetEifsNoDifs (Time eifsNoDifs)
 
virtual void SetForwardUpCallback (ForwardUpCallback upCallback)
 
virtual void SetLinkDownCallback (Callback< void > linkDown)
 
void SetPifs (Time pifs)
 
virtual void SetPromisc (void)
 Sets the interface in promiscuous mode. More...
 
void SetRifs (Time rifs)
 
void SetSifs (Time sifs)
 
void SetSlot (Time slotTime)
 
virtual void SetSsid (Ssid ssid)
 
virtual void SetWifiPhy (Ptr< WifiPhy > phy)
 
- Public Member Functions inherited from ns3::WifiMac
void ConfigureStandard (enum WifiPhyStandard standard)
 
Time GetMaxPropagationDelay (void) const
 
Time GetMsduLifetime (void) const
 
void NotifyPromiscRx (Ptr< const Packet > packet)
 
void NotifyRx (Ptr< const Packet > packet)
 
void NotifyRxDrop (Ptr< const Packet > packet)
 
void NotifyTx (Ptr< const Packet > packet)
 
void NotifyTxDrop (Ptr< const Packet > packet)
 
virtual void SetForwardUpCallback (Callback< void, Ptr< Packet >, Mac48Address, Mac48Address > upCallback)=0
 
void SetMaxPropagationDelay (Time delay)
 
- Public Member Functions inherited from ns3::Object
 Object ()
 
virtual ~Object ()
 
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 Run the DoDispose methods of this object and all the objects aggregated to it. More...
 
AggregateIterator GetAggregateIterator (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
template<typename T >
Ptr< T > GetObject (void) const
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 
void Initialize (void)
 This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCount & operator= (const SimpleRefCount &o)
 Assignment. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 
- 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::RegularWifiMac
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::WifiMac
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 Noop. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Member Functions

virtual void DeaggregateAmsduAndForward (Ptr< Packet > aggregatedPacket, const WifiMacHeader *hdr)
 This method is called to de-aggregate an A-MSDU and forward the constituent packets up the stack. More...
 
virtual void DoDispose (void)
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
virtual void DoInitialize (void)
 This method is called only once by Object::Initialize. More...
 
void ForwardDown (Ptr< const Packet > packet, Mac48Address from, Mac48Address to)
 Forward the packet down to DCF/EDCAF (enqueue the packet). More...
 
void ForwardDown (Ptr< const Packet > packet, Mac48Address from, Mac48Address to, uint8_t tid)
 Forward the packet down to DCF/EDCAF (enqueue the packet). More...
 
bool GetBeaconGeneration (void) const
 Return whether the AP is generating beacons. More...
 
HtCapabilities GetHtCapabilities (void) const
 Return the HT capability of the current AP. More...
 
SupportedRates GetSupportedRates (void) const
 Return an instance of SupportedRates that contains all rates that we support including HT rates. More...
 
virtual void Receive (Ptr< Packet > packet, const WifiMacHeader *hdr)
 This method acts as the MacRxMiddle receive callback and is invoked to notify us that a frame has been received. More...
 
void SendAssocResp (Mac48Address to, bool success)
 Forward an association response packet to the DCF. More...
 
void SendOneBeacon (void)
 Forward a beacon packet to the beacon special DCF. More...
 
void SendProbeResp (Mac48Address to)
 Forward a probe response packet to the DCF. More...
 
void SetBeaconGeneration (bool enable)
 Enable or disable beacon generation of the AP. More...
 
virtual void TxFailed (const WifiMacHeader &hdr)
 The packet we sent was successfully received by the receiver (i.e. More...
 
virtual void TxOk (const WifiMacHeader &hdr)
 The packet we sent was successfully received by the receiver (i.e. More...
 

Private Attributes

Ptr< DcaTxop > m_beaconDca
 Dedicated DcaTxop for beacons. More...
 
EventId m_beaconEvent
 Event to generate one beacon. More...
 
Time m_beaconInterval
 Interval between beacons. More...
 
Ptr< UniformRandomVariable > m_beaconJitter
 UniformRandomVariable used to randomize the time of the first beacon. More...
 
bool m_enableBeaconGeneration
 Flag if beacons are being generated. More...
 
bool m_enableBeaconJitter
 Flag if the first beacon should be generated at random time. More...
 

Additional Inherited Members

- Public Types inherited from ns3::RegularWifiMac
typedef Callback< void, Ptr
< Packet >, Mac48Address,
Mac48Address > 		ForwardUpCallback
 This type defines the callback of a higher layer that a WifiMac(-derived) object invokes to pass a packet up the stack. More...
 
- Protected Types inherited from ns3::RegularWifiMac
typedef std::map< AcIndex, Ptr
< EdcaTxopN > > 		EdcaQueues
 This type defines a mapping between an Access Category index, and a pointer to the corresponding channel access function. More...
 
- Protected Member Functions inherited from ns3::RegularWifiMac
virtual void FinishConfigureStandard (enum WifiPhyStandard standard)
 
void ForwardUp (Ptr< Packet > packet, Mac48Address from, Mac48Address to)
 Forward the packet up to the device. More...
 
Ptr< EdcaTxopN > GetBEQueue (void) const
 Accessor for the AC_BE channel access function. More...
 
Ptr< EdcaTxopN > GetBKQueue (void) const
 Accessor for the AC_BK channel access function. More...
 
Ptr< DcaTxop > GetDcaTxop (void) const
 Accessor for the DCF object. More...
 
bool GetHtSupported () const
 Return whether the device supports QoS. More...
 
bool GetQosSupported () const
 Return whether the device supports QoS. More...
 
Ptr< EdcaTxopN > GetVIQueue (void) const
 Accessor for the AC_VI channel access function. More...
 
Ptr< EdcaTxopN > GetVOQueue (void) const
 Accessor for the AC_VO channel access function. More...
 
virtual void SendAddBaResponse (const MgtAddBaRequestHeader *reqHdr, Mac48Address originator)
 This method can be called to accept a received ADDBA Request. More...
 
void SetHtSupported (bool enable)
 Enable or disable HT support for the device. More...
 
void SetQosSupported (bool enable)
 Enable or disable QoS support for the device. More...
 
void SetTypeOfStation (TypeOfStation type)
 This method is invoked by a subclass to specify what type of station it is implementing. More...
 
- Protected Member Functions inherited from ns3::WifiMac
void ConfigureDcf (Ptr< Dcf > dcf, uint32_t cwmin, uint32_t cwmax, enum AcIndex ac)
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void NotifyNewAggregate (void)
 This method is invoked whenever two sets of objects are aggregated together. More...
 
- 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...
 
- Protected Attributes inherited from ns3::RegularWifiMac
Ptr< DcaTxop > m_dca
 This holds a pointer to the DCF instance for this WifiMac - used for transmission of frames to non-QoS peers. More...
 
DcfManager * m_dcfManager
 DCF manager (access to channel) More...
 
EdcaQueues m_edca
 This is a map from Access Category index to the corresponding channel access function. More...
 
ForwardUpCallback m_forwardUp
 Callback to forward packet up the stack. More...
 
bool m_htSupported
 This Boolean is set true iff this WifiMac is to model 802.11n. More...
 
Callback< void > m_linkDown
 Callback when a link is down. More...
 
Callback< void > m_linkUp
 Callback when a link is up. More...
 
Ptr< MacLow > m_low
 MacLow (RTS, CTS, DATA, ACK etc.) More...
 
Ptr< WifiPhy > m_phy
 Wifi PHY. More...
 
bool m_qosSupported
 This Boolean is set true iff this WifiMac is to model 802.11e/WMM style Quality of Service. More...
 
MacRxMiddle * m_rxMiddle
 RX middle (de-fragmentation etc.) More...
 
Ssid m_ssid
 Service Set ID (SSID) More...
 
Ptr< WifiRemoteStationManager > m_stationManager
 Remote station manager (rate control, RTS/CTS/fragmentation thresholds etc.) More...
 
MacTxMiddle * m_txMiddle
 TX middle (aggregation etc.) More...
 

Detailed Description

Wi-Fi AP state machine

Handle association, dis-association and authentication, of STAs within an infrastructure BSS.

Config Paths

ns3::ApWifiMac is accessible through the following paths with Config::Set and Config::Connect:

  • /NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Mac/$ns3::ApWifiMac
  • /NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Mac/$ns3::RegularWifiMac/$ns3::ApWifiMac

Attributes

  • BeaconInterval: Delay between two beacons
    • Set with class: ns3::TimeValue
    • Underlying type: Time -9223372036854775808.0ns:+9223372036854775807.0ns
    • Initial value: +102400000.0ns
    • Flags: construct write read
  • BeaconJitter: A uniform random variable to cause the initial beacon starting time (after simulation time 0) to be distributed between 0 and the BeaconInterval.
  • EnableBeaconJitter: If beacons are enabled, whether to jitter the initial send event.
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: construct write read
  • BeaconGeneration: Whether or not beacons are generated.
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: construct write read

Attributes defined in parent class ns3::RegularWifiMac

  • QosSupported: This Boolean attribute is set to enable 802.11e/WMM-style QoS support at this STA
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: construct write read
  • HtSupported: This Boolean attribute is set to enable 802.11n support at this STA
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: construct write read
  • CtsToSelfSupported: Use CTS to Self when using a rate that is not in the basic set rate
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: construct write read
  • DcaTxop: The DcaTxop object
    • Set with class: ns3::PointerValue
    • Underlying type: ns3::Ptr< ns3::DcaTxop >
    • Flags: read
  • VO_EdcaTxopN: Queue that manages packets belonging to AC_VO access class
    • Set with class: ns3::PointerValue
    • Underlying type: ns3::Ptr< ns3::EdcaTxopN >
    • Flags: read
  • VI_EdcaTxopN: Queue that manages packets belonging to AC_VI access class
    • Set with class: ns3::PointerValue
    • Underlying type: ns3::Ptr< ns3::EdcaTxopN >
    • Flags: read
  • BE_EdcaTxopN: Queue that manages packets belonging to AC_BE access class
    • Set with class: ns3::PointerValue
    • Underlying type: ns3::Ptr< ns3::EdcaTxopN >
    • Flags: read
  • BK_EdcaTxopN: Queue that manages packets belonging to AC_BK access class
    • Set with class: ns3::PointerValue
    • Underlying type: ns3::Ptr< ns3::EdcaTxopN >
    • Flags: read

Attributes defined in parent class ns3::WifiMac

  • CtsTimeout: When this timeout expires, the RTS/CTS handshake has failed.
    • Set with class: ns3::TimeValue
    • Underlying type: Time -9223372036854775808.0ns:+9223372036854775807.0ns
    • Initial value: +75000.0ns
    • Flags: construct write read
  • AckTimeout: When this timeout expires, the DATA/ACK handshake has failed.
    • Set with class: ns3::TimeValue
    • Underlying type: Time -9223372036854775808.0ns:+9223372036854775807.0ns
    • Initial value: +75000.0ns
    • Flags: construct write read
  • BasicBlockAckTimeout: When this timeout expires, the BASIC_BLOCK_ACK_REQ/BASIC_BLOCK_ACK handshake has failed.
    • Set with class: ns3::TimeValue
    • Underlying type: Time -9223372036854775808.0ns:+9223372036854775807.0ns
    • Initial value: +281000.0ns
    • Flags: construct write read
  • CompressedBlockAckTimeout: When this timeout expires, the COMPRESSED_BLOCK_ACK_REQ/COMPRESSED_BLOCK_ACK handshake has failed.
    • Set with class: ns3::TimeValue
    • Underlying type: Time -9223372036854775808.0ns:+9223372036854775807.0ns
    • Initial value: +107000.0ns
    • Flags: construct write read
  • Sifs: The value of the SIFS constant.
    • Set with class: ns3::TimeValue
    • Underlying type: Time -9223372036854775808.0ns:+9223372036854775807.0ns
    • Initial value: +16000.0ns
    • Flags: construct write read
  • EifsNoDifs: The value of EIFS-DIFS
    • Set with class: ns3::TimeValue
    • Underlying type: Time -9223372036854775808.0ns:+9223372036854775807.0ns
    • Initial value: +60000.0ns
    • Flags: construct write read
  • Slot: The duration of a Slot.
    • Set with class: ns3::TimeValue
    • Underlying type: Time -9223372036854775808.0ns:+9223372036854775807.0ns
    • Initial value: +9000.0ns
    • Flags: construct write read
  • Pifs: The value of the PIFS constant.
    • Set with class: ns3::TimeValue
    • Underlying type: Time -9223372036854775808.0ns:+9223372036854775807.0ns
    • Initial value: +25000.0ns
    • Flags: construct write read
  • Rifs: The value of the RIFS constant.
    • Set with class: ns3::TimeValue
    • Underlying type: Time -9223372036854775808.0ns:+9223372036854775807.0ns
    • Initial value: +2000.0ns
    • Flags: construct write read
  • MaxPropagationDelay: The maximum propagation delay. Unused for now.
    • Set with class: ns3::TimeValue
    • Underlying type: Time -9223372036854775808.0ns:+9223372036854775807.0ns
    • Initial value: +3333.0ns
    • Flags: construct write read
  • Ssid: The ssid we want to belong to.
    • Set with class: SsidValue
    • Underlying type: Ssid
    • Initial value: default
    • Flags: construct write read

No TraceSources are defined for this type.

TraceSources defined in parent class ns3::RegularWifiMac

  • TxOkHeader: The header of successfully transmitted packet
  • TxErrHeader: The header of unsuccessfully transmitted packet

TraceSources defined in parent class ns3::WifiMac

  • MacTx: A packet has been received from higher layers and is being processed in preparation for queueing for transmission.
  • MacTxDrop: A packet has been dropped in the MAC layer before being queued for transmission.
  • MacPromiscRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a promiscuous trace,
  • MacRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a non-promiscuous trace,
  • MacRxDrop: A packet has been dropped in the MAC layer after it has been passed up from the physical layer.

Definition at line 40 of file ap-wifi-mac.h.

Constructor & Destructor Documentation

ns3::ApWifiMac::ApWifiMac ( )

Definition at line 76 of file ap-wifi-mac.cc.

References ns3::AP, m_beaconDca, ns3::RegularWifiMac::m_dcfManager, m_enableBeaconGeneration, ns3::RegularWifiMac::m_low, NS_LOG_FUNCTION, and ns3::RegularWifiMac::SetTypeOfStation().

+ Here is the call graph for this function:

ns3::ApWifiMac::~ApWifiMac ( )
virtual

Definition at line 92 of file ap-wifi-mac.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

int64_t ns3::ApWifiMac::AssignStreams ( int64_t  stream)

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.

Parameters
streamfirst stream index to use
Returns
the number of stream indices assigned by this model

Definition at line 185 of file ap-wifi-mac.cc.

References m_beaconJitter, NS_LOG_FUNCTION, and ns3::RandomVariableStream::SetStream().

+ Here is the call graph for this function:

void ns3::ApWifiMac::DeaggregateAmsduAndForward ( Ptr< Packet >  aggregatedPacket,
const WifiMacHeader *  hdr 
)
privatevirtual

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.

Parameters
aggregatedPacketthe Packet containing the A-MSDU.
hdra pointer to the MAC header for aggregatedPacket.

Reimplemented from ns3::RegularWifiMac.

Definition at line 635 of file ap-wifi-mac.cc.

References ns3::MsduAggregator::Deaggregate(), ForwardDown(), ns3::RegularWifiMac::ForwardUp(), ns3::RegularWifiMac::GetAddress(), ns3::WifiMacHeader::GetQosTid(), NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by Receive().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::ApWifiMac::DoDispose ( void  )
privatevirtual

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden version of this method and chain up to their parent's implementation once they are done. i.e., for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose method.

It is safe to call GetObject from within this method.

Reimplemented from ns3::RegularWifiMac.

Definition at line 98 of file ap-wifi-mac.cc.

References ns3::EventId::Cancel(), ns3::RegularWifiMac::DoDispose(), m_beaconDca, m_beaconEvent, m_enableBeaconGeneration, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

void ns3::ApWifiMac::DoInitialize ( void  )
privatevirtual

This method is called only once by Object::Initialize.

If the user calls Object::Initialize multiple times, DoInitialize is called only the first time.

Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject and AggregateObject from within this method.

Reimplemented from ns3::RegularWifiMac.

Definition at line 661 of file ap-wifi-mac.cc.

References ns3::EventId::Cancel(), ns3::RegularWifiMac::DoInitialize(), ns3::RegularWifiMac::GetAddress(), ns3::Time::GetMicroSeconds(), ns3::UniformRandomVariable::GetValue(), m_beaconDca, m_beaconEvent, m_beaconInterval, m_beaconJitter, m_enableBeaconGeneration, m_enableBeaconJitter, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), ns3::Simulator::ScheduleNow(), and SendOneBeacon().

+ Here is the call graph for this function:

void ns3::ApWifiMac::Enqueue ( Ptr< const Packet >  packet,
Mac48Address  to 
)
virtual
Parameters
packetthe packet to send.
tothe 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.

Implements ns3::RegularWifiMac.

Definition at line 278 of file ap-wifi-mac.cc.

References ns3::RegularWifiMac::m_low, and NS_LOG_FUNCTION.

void ns3::ApWifiMac::Enqueue ( Ptr< const Packet >  packet,
Mac48Address  to,
Mac48Address  from 
)
virtual
Parameters
packetthe packet to send.
tothe address to which the packet should be sent.
fromthe 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.

Reimplemented from ns3::RegularWifiMac.

Definition at line 268 of file ap-wifi-mac.cc.

References ForwardDown(), ns3::Mac48Address::IsBroadcast(), ns3::RegularWifiMac::m_stationManager, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

void ns3::ApWifiMac::ForwardDown ( Ptr< const Packet >  packet,
Mac48Address  from,
Mac48Address  to 
)
private

Forward the packet down to DCF/EDCAF (enqueue the packet).

This method is a wrapper for ForwardDown with traffic id.

Parameters
packetthe packet we are forwarding to DCF/EDCAF
fromthe address to be used for Address 3 field in the header
tothe address to be used for Address 1 field in the header

Definition at line 193 of file ap-wifi-mac.cc.

References ns3::RegularWifiMac::m_qosSupported, NS_LOG_FUNCTION, and ns3::QosUtilsGetTidForPacket().

Referenced by DeaggregateAmsduAndForward(), Enqueue(), and Receive().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::ApWifiMac::ForwardDown ( Ptr< const Packet >  packet,
Mac48Address  from,
Mac48Address  to,
uint8_t  tid 
)
private

Forward the packet down to DCF/EDCAF (enqueue the packet).

Parameters
packetthe packet we are forwarding to DCF/EDCAF
fromthe address to be used for Address 3 field in the header
tothe address to be used for Address 1 field in the header
tidthe traffic id for the packet

Definition at line 219 of file ap-wifi-mac.cc.

References ns3::RegularWifiMac::GetAddress(), ns3::RegularWifiMac::m_dca, ns3::RegularWifiMac::m_edca, ns3::RegularWifiMac::m_htSupported, ns3::RegularWifiMac::m_qosSupported, ns3::WifiMacHeader::NORMAL_ACK, NS_ASSERT, NS_LOG_FUNCTION, ns3::QosUtilsMapTidToAc(), ns3::WifiMacHeader::SetAddr1(), ns3::WifiMacHeader::SetAddr2(), ns3::WifiMacHeader::SetAddr3(), ns3::WifiMacHeader::SetDsFrom(), ns3::WifiMacHeader::SetDsNotTo(), ns3::WifiMacHeader::SetNoOrder(), ns3::WifiMacHeader::SetQosAckPolicy(), ns3::WifiMacHeader::SetQosNoAmsdu(), ns3::WifiMacHeader::SetQosNoEosp(), ns3::WifiMacHeader::SetQosTid(), ns3::WifiMacHeader::SetQosTxopLimit(), ns3::WifiMacHeader::SetType(), ns3::WifiMacHeader::SetTypeData(), and ns3::WIFI_MAC_QOSDATA.

+ Here is the call graph for this function:

bool ns3::ApWifiMac::GetBeaconGeneration ( void  ) const
private

Return whether the AP is generating beacons.

Returns
true if beacons are periodically generated, false otherwise

Definition at line 133 of file ap-wifi-mac.cc.

References m_enableBeaconGeneration, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

Time ns3::ApWifiMac::GetBeaconInterval ( void  ) const
Returns
the interval between two beacon transmissions.

Definition at line 140 of file ap-wifi-mac.cc.

References m_beaconInterval, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

HtCapabilities ns3::ApWifiMac::GetHtCapabilities ( void  ) const
private

Return the HT capability of the current AP.

Returns
the HT capability that we support

Definition at line 327 of file ap-wifi-mac.cc.

References ns3::WifiPhy::GetGreenfield(), ns3::WifiPhy::GetGuardInterval(), ns3::WifiPhy::GetLdpc(), ns3::WifiPhy::GetMcs(), ns3::WifiPhy::GetNMcs(), ns3::RegularWifiMac::m_phy, ns3::HtCapabilities::SetGreenfield(), ns3::HtCapabilities::SetHtSupported(), ns3::HtCapabilities::SetLdpc(), ns3::HtCapabilities::SetRxMcsBitmask(), and ns3::HtCapabilities::SetShortGuardInterval20().

Referenced by SendAssocResp(), SendOneBeacon(), and SendProbeResp().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

SupportedRates ns3::ApWifiMac::GetSupportedRates ( void  ) const
private

Return an instance of SupportedRates that contains all rates that we support including HT rates.

Returns
SupportedRates all rates that we support

Definition at line 295 of file ap-wifi-mac.cc.

References ns3::SupportedRates::AddSupportedRate(), ns3::WifiPhy::GetBssMembershipSelector(), ns3::WifiMode::GetDataRate(), ns3::WifiPhy::GetMode(), ns3::WifiPhy::GetNBssMembershipSelectors(), ns3::WifiPhy::GetNModes(), ns3::RegularWifiMac::m_htSupported, ns3::RegularWifiMac::m_phy, ns3::RegularWifiMac::m_stationManager, NS_LOG_FUNCTION, and ns3::SupportedRates::SetBasicRate().

Referenced by SendAssocResp(), SendOneBeacon(), and SendProbeResp().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Definition at line 49 of file ap-wifi-mac.cc.

References GetBeaconGeneration(), GetBeaconInterval(), m_beaconJitter, m_enableBeaconJitter, ns3::MakeTimeChecker(), SetBeaconGeneration(), SetBeaconInterval(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

void ns3::ApWifiMac::Receive ( Ptr< Packet >  packet,
const WifiMacHeader *  hdr 
)
privatevirtual

This method acts as the MacRxMiddle receive callback and is invoked to notify us that a frame has been received.

The implementation is intended to capture logic that is going to be common to all (or most) derived classes. Specifically, handling of Block Ack managment frames is dealt with here.

This method will need, however, to be overriden by derived classes so that they can perform their data handling before invoking the base version.

Parameters
packetthe packet that has been received.
hdra pointer to the MAC header of the received frame.

Reimplemented from ns3::RegularWifiMac.

Definition at line 466 of file ap-wifi-mac.cc.

References ns3::Packet::Copy(), DeaggregateAmsduAndForward(), ForwardDown(), ns3::RegularWifiMac::ForwardUp(), ns3::WifiMacHeader::GetAddr1(), ns3::WifiMacHeader::GetAddr2(), ns3::WifiMacHeader::GetAddr3(), ns3::RegularWifiMac::GetAddress(), ns3::WifiMode::GetDataRate(), ns3::MgtAssocRequestHeader::GetHtCapabilities(), ns3::WifiPhy::GetMcs(), ns3::WifiPhy::GetMode(), ns3::WifiPhy::GetNMcs(), ns3::WifiPhy::GetNModes(), ns3::WifiMacHeader::GetQosTid(), ns3::Packet::GetSize(), ns3::MgtAssocRequestHeader::GetSupportedRates(), ns3::WifiMacHeader::IsAssocReq(), ns3::Mac48Address::IsBroadcast(), ns3::WifiMacHeader::IsData(), ns3::WifiMacHeader::IsDisassociation(), ns3::WifiMacHeader::IsFromDs(), ns3::Mac48Address::IsGroup(), ns3::WifiMacHeader::IsMgt(), ns3::WifiMacHeader::IsProbeReq(), ns3::WifiMacHeader::IsQosAmsdu(), ns3::WifiMacHeader::IsQosData(), ns3::HtCapabilities::IsSupportedMcs(), ns3::SupportedRates::IsSupportedRate(), ns3::WifiMacHeader::IsToDs(), ns3::RegularWifiMac::m_htSupported, ns3::RegularWifiMac::m_phy, ns3::RegularWifiMac::m_stationManager, ns3::WifiMac::NotifyRxDrop(), NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::RegularWifiMac::Receive(), ns3::Packet::RemoveHeader(), SendAssocResp(), and SendProbeResp().

+ Here is the call graph for this function:

void ns3::ApWifiMac::SendAssocResp ( Mac48Address  to,
bool  success 
)
private

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.

Parameters
tothe address of the STA we are sending an association response to
successindicates whether the association was successful or not

Definition at line 371 of file ap-wifi-mac.cc.

References ns3::Packet::AddHeader(), ns3::RegularWifiMac::GetAddress(), GetHtCapabilities(), GetSupportedRates(), ns3::RegularWifiMac::m_dca, ns3::RegularWifiMac::m_htSupported, NS_LOG_FUNCTION, ns3::WifiMacHeader::SetAddr1(), ns3::WifiMacHeader::SetAddr2(), ns3::WifiMacHeader::SetAddr3(), ns3::WifiMacHeader::SetAssocResp(), ns3::WifiMacHeader::SetDsNotFrom(), ns3::WifiMacHeader::SetDsNotTo(), ns3::StatusCode::SetFailure(), ns3::WifiMacHeader::SetNoOrder(), and ns3::StatusCode::SetSuccess().

Referenced by Receive().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::ApWifiMac::SendOneBeacon ( void  )
private

Forward a beacon packet to the beacon special DCF.

Definition at line 410 of file ap-wifi-mac.cc.

References ns3::Packet::AddHeader(), ns3::RegularWifiMac::GetAddress(), ns3::Mac48Address::GetBroadcast(), GetHtCapabilities(), ns3::Time::GetMicroSeconds(), ns3::RegularWifiMac::GetSsid(), GetSupportedRates(), m_beaconDca, m_beaconEvent, m_beaconInterval, ns3::RegularWifiMac::m_htSupported, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), ns3::WifiMacHeader::SetAddr1(), ns3::WifiMacHeader::SetAddr2(), ns3::WifiMacHeader::SetAddr3(), ns3::WifiMacHeader::SetBeacon(), ns3::WifiMacHeader::SetDsNotFrom(), ns3::WifiMacHeader::SetDsNotTo(), ns3::WifiMacHeader::SetNoOrder(), and ns3::MgtProbeResponseHeader::SetSsid().

Referenced by DoInitialize(), SetBeaconGeneration(), and StartBeaconing().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::ApWifiMac::SendProbeResp ( Mac48Address  to)
private

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.

Parameters
tothe address of the STA we are sending a probe response to

Definition at line 341 of file ap-wifi-mac.cc.

References ns3::Packet::AddHeader(), ns3::RegularWifiMac::GetAddress(), GetHtCapabilities(), ns3::Time::GetMicroSeconds(), ns3::RegularWifiMac::GetSsid(), GetSupportedRates(), m_beaconInterval, ns3::RegularWifiMac::m_dca, ns3::RegularWifiMac::m_htSupported, NS_LOG_FUNCTION, ns3::WifiMacHeader::SetAddr1(), ns3::WifiMacHeader::SetAddr2(), ns3::WifiMacHeader::SetAddr3(), ns3::WifiMacHeader::SetDsNotFrom(), ns3::WifiMacHeader::SetDsNotTo(), ns3::WifiMacHeader::SetNoOrder(), ns3::WifiMacHeader::SetProbeResp(), and ns3::MgtProbeResponseHeader::SetSsid().

Referenced by Receive().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::ApWifiMac::SetAddress ( Mac48Address  address)
virtual
Parameters
addressthe current address of this MAC layer.

Reimplemented from ns3::RegularWifiMac.

Definition at line 108 of file ap-wifi-mac.cc.

References NS_LOG_FUNCTION, ns3::RegularWifiMac::SetAddress(), and ns3::RegularWifiMac::SetBssid().

+ Here is the call graph for this function:

void ns3::ApWifiMac::SetBeaconGeneration ( bool  enable)
private

Enable or disable beacon generation of the AP.

Parameters
enableenable or disable beacon generation

Definition at line 118 of file ap-wifi-mac.cc.

References ns3::EventId::Cancel(), m_beaconEvent, m_enableBeaconGeneration, NS_LOG_FUNCTION, ns3::Simulator::ScheduleNow(), and SendOneBeacon().

Referenced by GetTypeId().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::ApWifiMac::SetBeaconInterval ( Time  interval)
Parameters
intervalthe interval between two beacon transmissions.

Definition at line 167 of file ap-wifi-mac.cc.

References ns3::Time::GetMicroSeconds(), m_beaconInterval, NS_LOG_FUNCTION, and NS_LOG_WARN.

Referenced by GetTypeId().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::ApWifiMac::SetLinkUpCallback ( Callback< void >  linkUp)
virtual
Parameters
linkUpthe callback to invoke when the link becomes up.

Reimplemented from ns3::RegularWifiMac.

Definition at line 155 of file ap-wifi-mac.cc.

References NS_LOG_FUNCTION, and ns3::RegularWifiMac::SetLinkUpCallback().

+ Here is the call graph for this function:

void ns3::ApWifiMac::SetWifiRemoteStationManager ( Ptr< WifiRemoteStationManager >  stationManager)
virtual
Parameters
stationManagerthe station manager attached to this MAC.

Reimplemented from ns3::RegularWifiMac.

Definition at line 147 of file ap-wifi-mac.cc.

References m_beaconDca, NS_LOG_FUNCTION, and ns3::RegularWifiMac::SetWifiRemoteStationManager().

+ Here is the call graph for this function:

void ns3::ApWifiMac::StartBeaconing ( void  )

Start beacon transmission immediately.

Definition at line 178 of file ap-wifi-mac.cc.

References NS_LOG_FUNCTION, and SendOneBeacon().

+ Here is the call graph for this function:

bool ns3::ApWifiMac::SupportsSendFrom ( void  ) const
virtual
Returns
if this MAC supports sending from arbitrary address.

The interface may or may not support sending from arbitrary address. This function returns true if sending from arbitrary address is supported, false otherwise.

Reimplemented from ns3::RegularWifiMac.

Definition at line 288 of file ap-wifi-mac.cc.

References NS_LOG_FUNCTION.

void ns3::ApWifiMac::TxFailed ( const WifiMacHeader &  hdr)
privatevirtual

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.

Parameters
hdrthe header of the packet that we failed to sent

Reimplemented from ns3::RegularWifiMac.

Definition at line 452 of file ap-wifi-mac.cc.

References ns3::WifiMacHeader::GetAddr1(), ns3::WifiMacHeader::IsAssocResp(), ns3::RegularWifiMac::m_stationManager, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::RegularWifiMac::TxFailed().

+ Here is the call graph for this function:

void ns3::ApWifiMac::TxOk ( const WifiMacHeader &  hdr)
privatevirtual

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.

Parameters
hdrthe header of the packet that we successfully sent

Reimplemented from ns3::RegularWifiMac.

Definition at line 438 of file ap-wifi-mac.cc.

References ns3::WifiMacHeader::GetAddr1(), ns3::WifiMacHeader::IsAssocResp(), ns3::RegularWifiMac::m_stationManager, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::RegularWifiMac::TxOk().

+ Here is the call graph for this function:

Member Data Documentation

Ptr<DcaTxop> ns3::ApWifiMac::m_beaconDca
private

Dedicated DcaTxop for beacons.

Definition at line 207 of file ap-wifi-mac.h.

Referenced by ApWifiMac(), DoDispose(), DoInitialize(), SendOneBeacon(), and SetWifiRemoteStationManager().

EventId ns3::ApWifiMac::m_beaconEvent
private

Event to generate one beacon.

Definition at line 210 of file ap-wifi-mac.h.

Referenced by DoDispose(), DoInitialize(), SendOneBeacon(), and SetBeaconGeneration().

Time ns3::ApWifiMac::m_beaconInterval
private

Interval between beacons.

Definition at line 208 of file ap-wifi-mac.h.

Referenced by DoInitialize(), GetBeaconInterval(), SendOneBeacon(), SendProbeResp(), and SetBeaconInterval().

Ptr<UniformRandomVariable> ns3::ApWifiMac::m_beaconJitter
private

UniformRandomVariable used to randomize the time of the first beacon.

Definition at line 211 of file ap-wifi-mac.h.

Referenced by AssignStreams(), DoInitialize(), and GetTypeId().

bool ns3::ApWifiMac::m_enableBeaconGeneration
private

Flag if beacons are being generated.

Definition at line 209 of file ap-wifi-mac.h.

Referenced by ApWifiMac(), DoDispose(), DoInitialize(), GetBeaconGeneration(), and SetBeaconGeneration().

bool ns3::ApWifiMac::m_enableBeaconJitter
private

Flag if the first beacon should be generated at random time.

Definition at line 212 of file ap-wifi-mac.h.

Referenced by DoInitialize(), and GetTypeId().

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