ns-3
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:
Collaboration diagram for ns3::ApWifiMac:

List of all members.

Public Member Functions

virtual void SetWifiRemoteStationManager (Ptr< WifiRemoteStationManager > stationManager)
virtual void SetLinkUpCallback (Callback< void > linkUp)
virtual void Enqueue (Ptr< const Packet > packet, Mac48Address to)
virtual void Enqueue (Ptr< const Packet > packet, Mac48Address to, Mac48Address from)
virtual bool SupportsSendFrom (void) const
virtual void SetAddress (Mac48Address address)
void SetBeaconInterval (Time interval)
Time GetBeaconInterval (void) const
void StartBeaconing (void)
- Public Member Functions inherited from ns3::RegularWifiMac
void SetSlot (Time slotTime)
void SetSifs (Time sifs)
void SetEifsNoDifs (Time eifsNoDifs)
void SetPifs (Time pifs)
void SetCtsTimeout (Time ctsTimeout)
void SetAckTimeout (Time ackTimeout)
Time GetPifs (void) const
Time GetSifs (void) const
Time GetSlot (void) const
Time GetEifsNoDifs (void) const
Time GetCtsTimeout (void) const
Time GetAckTimeout (void) const
virtual Mac48Address GetAddress (void) const
virtual Ssid GetSsid (void) const
virtual void SetSsid (Ssid ssid)
virtual void SetBssid (Mac48Address bssid)
virtual Mac48Address GetBssid (void) const
virtual void SetPromisc (void)
 Sets the interface in promiscuous mode.
virtual void SetWifiPhy (Ptr< WifiPhy > phy)
virtual Ptr< WifiPhyGetWifiPhy () const
virtual Ptr
< WifiRemoteStationManager
GetWifiRemoteStationManager () const
virtual void SetForwardUpCallback (ForwardUpCallback upCallback)
virtual void SetLinkDownCallback (Callback< void > linkDown)
virtual void SetBasicBlockAckTimeout (Time blockAckTimeout)
virtual Time GetBasicBlockAckTimeout (void) const
virtual void SetCompressedBlockAckTimeout (Time blockAckTimeout)
virtual Time GetCompressedBlockAckTimeout (void) const
- Public Member Functions inherited from ns3::WifiMac
void SetMaxPropagationDelay (Time delay)
Time GetMsduLifetime (void) const
Time GetMaxPropagationDelay (void) const
virtual void SetForwardUpCallback (Callback< void, Ptr< Packet >, Mac48Address, Mac48Address > upCallback)=0
void NotifyTx (Ptr< const Packet > packet)
void NotifyTxDrop (Ptr< const Packet > packet)
void NotifyRx (Ptr< const Packet > packet)
void NotifyPromiscRx (Ptr< const Packet > packet)
void NotifyRxDrop (Ptr< const Packet > packet)
void ConfigureStandard (enum WifiPhyStandard standard)
- Public Member Functions inherited from ns3::Object
virtual TypeId GetInstanceTypeId (void) const
template<typename T >
Ptr< T > GetObject (void) const
template<typename T >
Ptr< T > GetObject (TypeId tid) const
void Dispose (void)
void AggregateObject (Ptr< Object > other)
AggregateIterator GetAggregateIterator (void) const
void Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
uint32_t GetReferenceCount (void) const
- Public Member Functions inherited from ns3::ObjectBase
void SetAttribute (std::string name, const AttributeValue &value)
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
void GetAttribute (std::string name, AttributeValue &value) const
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
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)
 This method returns the TypeId associated to ns3::ApWifiMac.

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 SetTypeOfStation (TypeOfStation type)
void ForwardUp (Ptr< Packet > packet, Mac48Address from, Mac48Address to)
virtual void SendAddBaResponse (const MgtAddBaRequestHeader *reqHdr, Mac48Address originator)
void SetQosSupported (bool enable)
bool GetQosSupported () const
- Protected Member Functions inherited from ns3::WifiMac
void ConfigureDcf (Ptr< Dcf > dcf, uint32_t cwmin, uint32_t cwmax, enum AcIndex ac)
void ConfigureCCHDcf (Ptr< Dcf > dcf, uint32_t cwmin, uint32_t cwmax, enum AcIndex ac)
- Protected Member Functions inherited from ns3::Object
virtual void NotifyNewAggregate (void)
 Object (const Object &o)
- Protected Attributes inherited from ns3::RegularWifiMac
MacRxMiddlem_rxMiddle
MacTxMiddlem_txMiddle
Ptr< MacLowm_low
DcfManagerm_dcfManager
Ptr< WifiPhym_phy
Ptr< WifiRemoteStationManagerm_stationManager
ForwardUpCallback m_forwardUp
Callback< void > m_linkUp
Callback< void > m_linkDown
Ssid m_ssid
Ptr< DcaTxopm_dca
EdcaQueues m_edca
bool m_qosSupported

Detailed Description

Wi-Fi AP state machine

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


Member Function Documentation

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.

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.

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

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

Referenced by GetTypeId().

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

This method returns the TypeId associated to ns3::ApWifiMac.

This object 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 defined for this type:

  • 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:

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 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.

Reimplemented from ns3::RegularWifiMac.

References GetBeaconInterval(), ns3::MicroSeconds(), SetBeaconInterval(), and ns3::TypeId::SetParent().

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

Reimplemented from ns3::RegularWifiMac.

References ns3::RegularWifiMac::SetBssid().

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

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

Referenced by GetTypeId().

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

Reimplemented from ns3::RegularWifiMac.

References NS_LOG_FUNCTION.

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

Reimplemented from ns3::RegularWifiMac.

References NS_LOG_FUNCTION.

void ns3::ApWifiMac::StartBeaconing ( void  )

Start beacon transmission immediately.

References NS_LOG_FUNCTION.


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