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

STAs communicate with each directly outside the context of a BSSIn OCB mac mode,synchronization, association, dis-association and authentication of normal wifi are not used for wireless access in vehicular environments. More...

#include <ocb-wifi-mac.h>

+ Inheritance diagram for ns3::OcbWifiMac:
+ Collaboration diagram for ns3::OcbWifiMac:

Public Member Functions

 OcbWifiMac (void)
 
virtual ~OcbWifiMac (void)
 
void AddReceiveVscCallback (OrganizationIdentifier oi, VscCallback cb)
 
void ConfigureEdca (uint32_t cwmin, uint32_t cwmax, uint32_t aifsn, enum AcIndex ac)
 
virtual void Enqueue (Ptr< const Packet > packet, Mac48Address to)
 
virtual Mac48Address GetBssid (void) const
 
virtual Ssid GetSsid (void) const
 
void RemoveReceiveVscCallback (OrganizationIdentifier oi)
 
void SendVsc (Ptr< Packet > vsc, Mac48Address peer, OrganizationIdentifier oi)
 
virtual void SetBssid (Mac48Address bssid)
 
virtual void SetLinkDownCallback (Callback< void > linkDown)
 
virtual void SetLinkUpCallback (Callback< void > linkUp)
 SetLinkUpCallback and SetLinkDownCallback will be overloaded In OCB mode, stations can send packets directly whenever they want so the link is always up and never down even during channel switch. More...
 
virtual void SetSsid (Ssid ssid)
 
- Public Member Functions inherited from ns3::RegularWifiMac
 RegularWifiMac ()
 
virtual ~RegularWifiMac ()
 
virtual void Enqueue (Ptr< const Packet > packet, Mac48Address to, Mac48Address from)
 
Time GetAckTimeout (void) const
 
virtual Mac48Address GetAddress (void) const
 
virtual Time GetBasicBlockAckTimeout (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 Ptr< WifiPhyGetWifiPhy () const
 
virtual Ptr
< WifiRemoteStationManager
GetWifiRemoteStationManager () const
 
void SetAckTimeout (Time ackTimeout)
 
virtual void SetAddress (Mac48Address address)
 
virtual void SetBasicBlockAckTimeout (Time blockAckTimeout)
 
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)
 
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 SetWifiPhy (Ptr< WifiPhy > phy)
 
virtual void SetWifiRemoteStationManager (Ptr< WifiRemoteStationManager > stationManager)
 
virtual bool SupportsSendFrom (void) const
 
- 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...
 
SimpleRefCountoperator= (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...
 

Protected Member Functions

virtual void FinishConfigureStandard (enum WifiPhyStandard standard)
 
- Protected Member Functions inherited from ns3::RegularWifiMac
virtual void DeaggregateAmsduAndForward (Ptr< Packet > aggregatedPacket, const WifiMacHeader *hdr)
 This method can be called to de-aggregate an A-MSDU and forward the constituent packets up the stack. More...
 
virtual void DoDispose ()
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
virtual void DoInitialize ()
 This method is called only once by Object::Initialize. More...
 
void ForwardUp (Ptr< Packet > packet, Mac48Address from, Mac48Address to)
 Forward the packet up to the device. More...
 
Ptr< EdcaTxopNGetBEQueue (void) const
 Accessor for the AC_BE channel access function. More...
 
Ptr< EdcaTxopNGetBKQueue (void) const
 Accessor for the AC_BK channel access function. More...
 
Ptr< DcaTxopGetDcaTxop (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< EdcaTxopNGetVIQueue (void) const
 Accessor for the AC_VI channel access function. More...
 
Ptr< EdcaTxopNGetVOQueue (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...
 
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...
 
- 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...
 

Private Member Functions

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

Private Attributes

VendorSpecificContentManager m_vscManager
 

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 Attributes inherited from ns3::RegularWifiMac
Ptr< DcaTxopm_dca
 This holds a pointer to the DCF instance for this WifiMac - used for transmission of frames to non-QoS peers. More...
 
DcfManagerm_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< MacLowm_low
 MacLow (RTS, CTS, DATA, ACK etc.) More...
 
Ptr< WifiPhym_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...
 
MacRxMiddlem_rxMiddle
 RX middle (de-fragmentation etc.) More...
 
Ssid m_ssid
 Service Set ID (SSID) More...
 
Ptr< WifiRemoteStationManagerm_stationManager
 Remote station manager (rate control, RTS/CTS/fragmentation thresholds etc.) More...
 
MacTxMiddlem_txMiddle
 TX middle (aggregation etc.) More...
 

Detailed Description

STAs communicate with each directly outside the context of a BSS

In OCB mac mode,synchronization, association, dis-association and authentication of normal wifi are not used for wireless access in vehicular environments.

Although Timing Advertisement frame is a specific management frame defined in 802.11p. It is mainly used by IEEE Std 1609.4 for channel switch synchronization. However in simulation nodes are supposed to have GPS synchronization ability, so we will not implement this feature.

Config Paths

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

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

No Attributes are defined for this type.
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 47 of file ocb-wifi-mac.h.

Constructor & Destructor Documentation

ns3::OcbWifiMac::~OcbWifiMac ( void  )
virtual

Definition at line 73 of file ocb-wifi-mac.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::OcbWifiMac::AddReceiveVscCallback ( OrganizationIdentifier  oi,
VscCallback  cb 
)
Parameters
oiOrganization Identifier
cbcallback to invoke whenever a vender specific action frame has been received and must be forwarded to the higher layers. every node shall register first if it wants to receive specific vendor specific content.

Definition at line 106 of file ocb-wifi-mac.cc.

References m_vscManager, NS_LOG_FUNCTION, and ns3::VendorSpecificContentManager::RegisterVscCallback().

+ Here is the call graph for this function:

void ns3::OcbWifiMac::ConfigureEdca ( uint32_t  cwmin,
uint32_t  cwmax,
uint32_t  aifsn,
enum AcIndex  ac 
)
Parameters
cwminthe min contention window
cwmaxthe max contention window
aifsnthe arbitration inter-frame space
acthe access category index

configure EDCA queue parameters

Definition at line 309 of file ocb-wifi-mac.cc.

References ns3::AC_BE, ns3::AC_BE_NQOS, ns3::AC_BK, ns3::AC_UNDEF, ns3::AC_VI, ns3::AC_VO, ns3::RegularWifiMac::GetBEQueue(), ns3::RegularWifiMac::GetBKQueue(), ns3::RegularWifiMac::GetDcaTxop(), ns3::RegularWifiMac::GetVIQueue(), ns3::RegularWifiMac::GetVOQueue(), and NS_FATAL_ERROR.

Referenced by FinishConfigureStandard().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::OcbWifiMac::FinishConfigureStandard ( enum WifiPhyStandard  standard)
protectedvirtual
Parameters
standardthe phy standard to be used

This method is called by ns3::WifiMac::ConfigureStandard to complete the configuration process for a requested phy standard.

This method may be overriden by a derived class (e.g., in order to apply DCF or EDCA parameters specific to the usage model it is dealing with), in which case the reimplementation may choose to deal with certain values in the WifiPhyStandard enumeration, and chain up to this implementation to deal with the remainder.

Reimplemented from ns3::RegularWifiMac.

Definition at line 351 of file ocb-wifi-mac.cc.

References ns3::AC_BE, ns3::AC_BE_NQOS, ns3::AC_BK, ns3::AC_VI, ns3::AC_VO, ConfigureEdca(), NS_ASSERT, ns3::WIFI_PHY_STANDARD_80211_10MHZ, and ns3::WIFI_PHY_STANDARD_80211a.

+ Here is the call graph for this function:

Mac48Address ns3::OcbWifiMac::GetBssid ( void  ) const
virtual
Parameters
bssidthe BSSID of the network that this device belongs to.

This method shall not be used in WAVE environment and here it will overloaded to log warn message

Reimplemented from ns3::RegularWifiMac.

Definition at line 141 of file ocb-wifi-mac.cc.

References NS_FATAL_ERROR, and ns3::WILDCARD_BSSID.

Ssid ns3::OcbWifiMac::GetSsid ( void  ) const
virtual
Returns
the ssid which this MAC layer is going to try to stay in.

This method shall not be used in WAVE environment and here it will overloaded to log warn message

Reimplemented from ns3::RegularWifiMac.

Definition at line 126 of file ocb-wifi-mac.cc.

References ns3::RegularWifiMac::GetSsid(), and NS_FATAL_ERROR.

+ Here is the call graph for this function:

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

Definition at line 44 of file ocb-wifi-mac.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

void ns3::OcbWifiMac::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 240 of file ocb-wifi-mac.cc.

References ns3::CATEGORY_OF_VSA, ns3::RegularWifiMac::DeaggregateAmsduAndForward(), ns3::VendorSpecificContentManager::FindVscCallback(), ns3::RegularWifiMac::ForwardUp(), ns3::WifiMacHeader::GetAddr1(), ns3::WifiMacHeader::GetAddr2(), ns3::WifiMacHeader::GetAddr3(), ns3::RegularWifiMac::GetAddress(), ns3::VendorSpecificActionHeader::GetCategory(), ns3::VendorSpecificActionHeader::GetOrganizationIdentifier(), ns3::WifiMacHeader::IsAction(), ns3::WifiMacHeader::IsCtl(), ns3::WifiMacHeader::IsData(), ns3::Mac48Address::IsGroup(), ns3::WifiMacHeader::IsMgt(), ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), ns3::WifiMacHeader::IsQosAmsdu(), ns3::WifiMacHeader::IsQosData(), m_vscManager, ns3::WifiMac::NotifyRxDrop(), NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::Packet::PeekHeader(), ns3::RegularWifiMac::Receive(), ns3::Packet::RemoveHeader(), and ns3::WILDCARD_BSSID.

+ Here is the call graph for this function:

void ns3::OcbWifiMac::RemoveReceiveVscCallback ( OrganizationIdentifier  oi)

Definition at line 113 of file ocb-wifi-mac.cc.

References ns3::VendorSpecificContentManager::DeregisterVscCallback(), m_vscManager, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

void ns3::OcbWifiMac::SendVsc ( Ptr< Packet vsc,
Mac48Address  peer,
OrganizationIdentifier  oi 
)
Parameters
vscmanagement packet to send.
peerthe address to which the packet should be sent.
oiOrganization Identifier field see 7.3.1.31 Organization Identifier field and 10.3.29 Vendor-specific action

management information can be transmitted over vender specific action frame. This will be mainly called by IEEE Std 1609.4 to send WSA from IEEE Std 1609.3

Definition at line 79 of file ocb-wifi-mac.cc.

References ns3::Packet::AddHeader(), ns3::RegularWifiMac::GetAddress(), ns3::RegularWifiMac::m_dca, ns3::RegularWifiMac::m_edca, ns3::RegularWifiMac::m_qosSupported, NS_LOG_FUNCTION, ns3::QosUtilsGetTidForPacket(), ns3::QosUtilsMapTidToAc(), ns3::WifiMacHeader::SetAction(), ns3::WifiMacHeader::SetAddr1(), ns3::WifiMacHeader::SetAddr2(), ns3::WifiMacHeader::SetAddr3(), ns3::WifiMacHeader::SetDsNotFrom(), ns3::WifiMacHeader::SetDsNotTo(), ns3::VendorSpecificActionHeader::SetOrganizationIdentifier(), and ns3::WILDCARD_BSSID.

+ Here is the call graph for this function:

void ns3::OcbWifiMac::SetBssid ( Mac48Address  bssid)
virtual
Parameters
bssidthe BSSID of the network that this device belongs to. This method shall not be used in WAVE environment and here it will overloaded to log warn message

Reimplemented from ns3::RegularWifiMac.

Definition at line 135 of file ocb-wifi-mac.cc.

References NS_FATAL_ERROR.

void ns3::OcbWifiMac::SetLinkDownCallback ( Callback< void >  linkDown)
virtual
Parameters
linkDownthe callback to invoke when the link becomes down.

Reimplemented from ns3::RegularWifiMac.

Definition at line 160 of file ocb-wifi-mac.cc.

References NS_LOG_FUNCTION, NS_LOG_WARN, and ns3::RegularWifiMac::SetLinkDownCallback().

+ Here is the call graph for this function:

void ns3::OcbWifiMac::SetLinkUpCallback ( Callback< void >  linkUp)
virtual

SetLinkUpCallback and SetLinkDownCallback will be overloaded In OCB mode, stations can send packets directly whenever they want so the link is always up and never down even during channel switch.

Parameters
linkUpthe callback to invoke when the link becomes up.

Reimplemented from ns3::RegularWifiMac.

Definition at line 148 of file ocb-wifi-mac.cc.

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

+ Here is the call graph for this function:

void ns3::OcbWifiMac::SetSsid ( Ssid  ssid)
virtual
Parameters
ssidthe current ssid of this MAC layer.

This method shall not be used in WAVE environment and here it will overloaded to log warn message

Reimplemented from ns3::RegularWifiMac.

Definition at line 120 of file ocb-wifi-mac.cc.

References NS_LOG_WARN.

Member Data Documentation

VendorSpecificContentManager ns3::OcbWifiMac::m_vscManager
private

Definition at line 137 of file ocb-wifi-mac.h.

Referenced by AddReceiveVscCallback(), Receive(), and RemoveReceiveVscCallback().


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