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

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:

Public Member Functions

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)
 
virtual bool SupportsSendFrom (void) const
 
- Public Member Functions inherited from ns3::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
 
Time GetEifsNoDifs (void) const
 
Time GetPifs (void) const
 
Time GetSifs (void) const
 
Time GetSlot (void) const
 
virtual Ssid GetSsid (void) const
 
virtual Ptr< WifiPhyGetWifiPhy () const
 
virtual Ptr
< WifiRemoteStationManager
GetWifiRemoteStationManager () const
 
void RestartAccess (void)
 
void SetAckTimeout (Time ackTimeout)
 
virtual void SetBasicBlockAckTimeout (Time blockAckTimeout)
 
virtual void SetBssid (Mac48Address bssid)
 
virtual void SetCompressedBlockAckTimeout (Time blockAckTimeout)
 
void SetCtsTimeout (Time ctsTimeout)
 
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 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
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 
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)
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
 
uint32_t GetReferenceCount (void) const
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 
void Ref (void) const
 
void Unref (void) const
 
- Public Member Functions inherited from ns3::ObjectBase
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)
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

Private Member Functions

virtual void DeaggregateAmsduAndForward (Ptr< Packet > aggregatedPacket, const WifiMacHeader *hdr)
 
virtual void DoDispose (void)
 
virtual void DoInitialize (void)
 
void ForwardDown (Ptr< const Packet > packet, Mac48Address from, Mac48Address to)
 
void ForwardDown (Ptr< const Packet > packet, Mac48Address from, Mac48Address to, uint8_t tid)
 
bool GetBeaconGeneration (void) const
 
SupportedRates GetSupportedRates (void) const
 
virtual void Receive (Ptr< Packet > packet, const WifiMacHeader *hdr)
 
void SendAssocResp (Mac48Address to, bool success)
 
void SendOneBeacon (void)
 
void SendProbeResp (Mac48Address to)
 
void SetBeaconGeneration (bool enable)
 
virtual void TxFailed (const WifiMacHeader &hdr)
 
virtual void TxOk (const WifiMacHeader &hdr)
 

Private Attributes

Ptr< DcaTxopm_beaconDca
 
EventId m_beaconEvent
 
Time m_beaconInterval
 
bool m_enableBeaconGeneration
 

Additional Inherited Members

- Public Types inherited from ns3::RegularWifiMac
typedef Callback< void, Ptr
< Packet >, Mac48Address,
Mac48Address
ForwardUpCallback
 
- Protected Types inherited from ns3::RegularWifiMac
typedef std::map< AcIndex, Ptr
< EdcaTxopN > > 
EdcaQueues
 
- Protected Member Functions inherited from ns3::RegularWifiMac
virtual void FinishConfigureStandard (enum WifiPhyStandard standard)
 
void ForwardUp (Ptr< Packet > packet, Mac48Address from, Mac48Address to)
 
bool GetQosSupported () const
 
bool IsRxRadio (void)
 
bool IsTxRadio (void)
 
virtual void SendAddBaResponse (const MgtAddBaRequestHeader *reqHdr, Mac48Address originator)
 
void SetQosSupported (bool enable)
 
void SetRxRadio (bool isRx, Ptr< Node > node, Ptr< Repository > repo, Ptr< PUModel > puModel, Ptr< WifiPhy > phy)
 
void SetTxRadio (bool isTx)
 
void SetTypeOfStation (TypeOfStation type)
 
- Protected Member Functions inherited from ns3::WifiMac
void ConfigureCCHDcf (Ptr< Dcf > dcf, uint32_t cwmin, uint32_t cwmax, enum AcIndex ac)
 
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)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 
- Protected Attributes inherited from ns3::RegularWifiMac
Ptr< DcaTxopm_dca
 
DcfManagerm_dcfManager
 
EdcaQueues m_edca
 
ForwardUpCallback m_forwardUp
 
Callback< void > m_linkDown
 
Callback< void > m_linkUp
 
Ptr< MacLowm_low
 
Ptr< WifiPhym_phy
 
bool m_qosSupported
 
MacRxMiddlem_rxMiddle
 
Ssid m_ssid
 
Ptr< WifiRemoteStationManagerm_stationManager
 
MacTxMiddlem_txMiddle
 

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: TimeValue
    • Underlying type: Time
    • Initial value: +102400000.0ns
    • 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
  • 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
  • SensingTime: The sensing time of the node
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +100000000.0ns
    • Flags: construct write read
  • TransmissionTime: The transmission time of the node
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +1000000000.0ns
    • Flags: construct write read
  • ProbabilityMisDetect: The probability that a node mis-detects a Primary User
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 0.1
    • Flags: construct write read

Attributes defined in parent class ns3::WifiMac

  • CtsTimeout: When this timeout expires, the RTS/CTS handshake has failed.
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +75000.0ns
    • Flags: construct write read
  • AckTimeout: When this timeout expires, the DATA/ACK handshake has failed.
    • Set with class: TimeValue
    • Underlying type: Time
    • 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: TimeValue
    • Underlying type: Time
    • 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: TimeValue
    • Underlying type: Time
    • Initial value: +99000.0ns
    • Flags: construct write read
  • Sifs: The value of the SIFS constant.
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +16000.0ns
    • Flags: construct write read
  • EifsNoDifs: The value of EIFS-DIFS
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +60000.0ns
    • Flags: construct write read
  • Slot: The duration of a Slot.
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +9000.0ns
    • Flags: construct write read
  • Pifs: The value of the PIFS constant.
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +25000.0ns
    • Flags: construct write read
  • MaxPropagationDelay: The maximum propagation delay. Unused for now.
    • Set with class: TimeValue
    • Underlying type: Time
    • 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 39 of file ap-wifi-mac.h.

Member Function Documentation

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 549 of file ap-wifi-mac.cc.

References ns3::RegularWifiMac::GetAddress(), NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by Receive().

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 89 of file ap-wifi-mac.cc.

References ns3::EventId::Cancel(), ns3::RegularWifiMac::DoDispose(), and NS_LOG_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 575 of file ap-wifi-mac.cc.

References ns3::EventId::Cancel(), ns3::RegularWifiMac::DoInitialize(), NS_LOG_FUNCTION, and ns3::Simulator::ScheduleNow().

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 259 of file ap-wifi-mac.cc.

References 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 249 of file ap-wifi-mac.cc.

References ns3::Mac48Address::IsBroadcast(), and NS_LOG_FUNCTION.

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

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

References NS_LOG_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 407 of file ap-wifi-mac.cc.

References ns3::Packet::Copy(), DeaggregateAmsduAndForward(), ns3::RegularWifiMac::GetAddress(), ns3::WifiMode::GetDataRate(), ns3::WifiPhy::GetMode(), ns3::WifiPhy::GetNModes(), ns3::Packet::GetSize(), ns3::Mac48Address::IsBroadcast(), ns3::Mac48Address::IsGroup(), ns3::WifiMac::NotifyRxDrop(), NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::RegularWifiMac::Receive(), and ns3::Packet::RemoveHeader().

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

Reimplemented from ns3::RegularWifiMac.

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

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

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

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

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

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 146 of file ap-wifi-mac.cc.

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

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

Reimplemented from ns3::RegularWifiMac.

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

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

void ns3::ApWifiMac::StartBeaconing ( void  )

Start beacon transmission immediately.

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

References NS_LOG_FUNCTION.


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