CW-MAC protocol, similar in idea to the 802.11 DCF with constant backoff window. More...
#include "uan-mac-cw.h"
Public Types | |
typedef void(* | QueueTracedCallback) (Ptr< const Packet > packet, uint16_t proto) |
TracedCallback signature for enqueue/dequeue of a packet. | |
Public Types inherited from ns3::UanMac | |
typedef void(* | PacketModeTracedCallback) (Ptr< const Packet > packet, UanTxMode mode) |
TracedCallback signature for packet reception/enqueue/dequeue events. | |
Public Member Functions | |
UanMacCw () | |
Default constructor. | |
~UanMacCw () override | |
Dummy destructor, DoDispose. | |
int64_t | AssignStreams (int64_t stream) override |
Assign a fixed random variable stream number to the random variables used by this model. | |
void | AttachPhy (Ptr< UanPhy > phy) override |
Attach PHY layer to this MAC. | |
void | Clear () override |
Clears all pointer references. | |
bool | Enqueue (Ptr< Packet > pkt, uint16_t protocolNumber, const Address &dest) override |
Enqueue packet to be transmitted. | |
virtual uint32_t | GetCw () |
Get the contention window size. | |
virtual Time | GetSlotTime () |
Get the slot time duration. | |
void | NotifyCcaEnd () override |
Called when UanPhy stops sensing channel is busy. | |
void | NotifyCcaStart () override |
Called when UanPhy begins sensing channel is busy. | |
void | NotifyRxEndError () override |
Called when UanPhy finishes receiving packet in error. | |
void | NotifyRxEndOk () override |
Called when UanPhy finishes receiving packet without error. | |
void | NotifyRxStart () override |
Called when UanPhy begins receiving packet. | |
void | NotifyTxEnd () override |
Function called when Phy object finishes transmitting packet. | |
void | NotifyTxStart (Time duration) override |
Called when transmission starts from Phy object. | |
virtual void | SetCw (uint32_t cw) |
Set the contention window size. | |
void | SetForwardUpCb (Callback< void, Ptr< Packet >, uint16_t, const Mac8Address & > cb) override |
Set the callback to forward packets up to higher layers. | |
virtual void | SetSlotTime (Time duration) |
Set the slot time duration. | |
Public Member Functions inherited from ns3::UanMac | |
UanMac () | |
Default constructor. | |
virtual int64_t | AssignStreams (int64_t stream)=0 |
Assign a fixed random variable stream number to the random variables used by this model. | |
virtual void | AttachPhy (Ptr< UanPhy > phy)=0 |
Attach PHY layer to this MAC. | |
virtual void | Clear ()=0 |
Clears all pointer references. | |
virtual bool | Enqueue (Ptr< Packet > pkt, uint16_t protocolNumber, const Address &dest)=0 |
Enqueue packet to be transmitted. | |
virtual Address | GetAddress () |
Get the MAC Address. | |
virtual Address | GetBroadcast () const |
Get the broadcast address. | |
uint32_t | GetTxModeIndex () const |
Get the Tx mode index (Modulation type). | |
virtual void | SetAddress (Mac8Address addr) |
Set the address. | |
virtual void | SetForwardUpCb (Callback< void, Ptr< Packet >, uint16_t, const Mac8Address & > cb)=0 |
Set the callback to forward packets up to higher layers. | |
void | SetTxModeIndex (uint32_t txModeIndex) |
Set the Tx mode index (Modulation type). | |
Public Member Functions inherited from ns3::Object | |
Object () | |
Constructor. | |
~Object () override | |
Destructor. | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. | |
void | Dispose () |
Dispose of this Object. | |
AggregateIterator | GetAggregateIterator () const |
Get an iterator to the Objects aggregated to this one. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated Object. | |
template<> | |
Ptr< Object > | GetObject () const |
Specialization of () for objects of type ns3::Object. | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. | |
template<> | |
Ptr< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. | |
void | Initialize () |
Invoke DoInitialize on all Objects aggregated to this one. | |
bool | IsInitialized () const |
Check if the object has been initialized. | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount () | |
Default constructor. | |
SimpleRefCount (const SimpleRefCount &o) | |
Copy constructor. | |
uint32_t | GetReferenceCount () const |
Get the reference count of the object. | |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
Assignment operator. | |
void | Ref () const |
Increment the reference count. | |
void | Unref () const |
Decrement the reference count. | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value) const |
Get the value of an attribute, raising fatal errors if unsuccessful. | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. | |
virtual TypeId | GetInstanceTypeId () const =0 |
Get the most derived TypeId for this Object. | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. | |
Public Member Functions inherited from ns3::UanPhyListener | |
virtual | ~UanPhyListener () |
Default destructor. | |
virtual void | NotifyCcaEnd ()=0 |
Called when UanPhy stops sensing channel is busy. | |
virtual void | NotifyCcaStart ()=0 |
Called when UanPhy begins sensing channel is busy. | |
virtual void | NotifyRxEndError ()=0 |
Called when UanPhy finishes receiving packet in error. | |
virtual void | NotifyRxEndOk ()=0 |
Called when UanPhy finishes receiving packet without error. | |
virtual void | NotifyRxStart ()=0 |
Called when UanPhy begins receiving packet. | |
virtual void | NotifyTxEnd ()=0 |
Function called when Phy object finishes transmitting packet. | |
virtual void | NotifyTxStart (Time duration)=0 |
Called when transmission starts from Phy object. | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::UanMac | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Protected Member Functions | |
void | DoDispose () override |
Destructor implementation. | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. | |
virtual void | DoDispose () |
Destructor implementation. | |
virtual void | DoInitialize () |
Initialize() implementation. | |
virtual void | NotifyNewAggregate () |
Notify all Objects aggregated to this one of a new Object being aggregated. | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. | |
Private Types | |
enum | State { IDLE , CCABUSY , RUNNING , TX } |
Enum defining possible Phy states. More... | |
Private Member Functions | |
void | EndTx () |
End TX state. | |
void | PhyRxPacketError (Ptr< Packet > packet, double sinr) |
Packet received at lower layer in error. | |
void | PhyRxPacketGood (Ptr< Packet > packet, double sinr, UanTxMode mode) |
Receive packet from lower layer (passed to PHY as callback). | |
void | SaveTimer () |
Cancel SendEvent and save remaining delay. | |
void | SendPacket () |
Send packet on PHY. | |
void | StartTimer () |
Schedule SendPacket after delay. | |
Private Attributes | |
bool | m_cleared |
Flag when we've been cleared. | |
uint32_t | m_cw |
Contention window size. | |
TracedCallback< Ptr< const Packet >, uint16_t > | m_dequeueLogger |
A packet was passed down to the PHY from the MAC. | |
TracedCallback< Ptr< const Packet >, uint16_t > | m_enqueueLogger |
A packet arrived at the MAC for transmission. | |
Callback< void, Ptr< Packet >, uint16_t, const Mac8Address & > | m_forwardUpCb |
Forwarding up callback. | |
Ptr< UanPhy > | m_phy |
PHY layer attached to this MAC. | |
Ptr< Packet > | m_pktTx |
Next packet to send. | |
uint16_t | m_pktTxProt |
Next packet protocol number (usage varies by MAC). | |
Ptr< UniformRandomVariable > | m_rv |
Provides uniform random variable for contention window. | |
TracedCallback< Ptr< const Packet >, UanTxMode > | m_rxLogger |
A packet destined for this MAC was received. | |
Time | m_savedDelayS |
Remaining delay until next send. | |
EventId | m_sendEvent |
Scheduled SendPacket event. | |
Time | m_sendTime |
Time to send next packet. | |
Time | m_slotTime |
Slot time duration. | |
State | m_state |
Current state. | |
bool | m_txOngoing |
Tx is ongoing. | |
Additional Inherited Members | |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
CW-MAC protocol, similar in idea to the 802.11 DCF with constant backoff window.
For more information on this MAC protocol, see: Parrish, N.; Tracy, L.; Roy, S.; Arabshahi, P.; Fox, W., "System Design Considerations for Undersea Networks: Link and Multiple Access Protocols," Selected Areas in Communications, IEEE Journal on , vol.26, no.9, pp.1720-1730, December 2008
ns3::UanMacCw is accessible through the following paths with Config::Set and Config::Connect:
Time
+9.22337e+18ns:+9.22337e+18ns Size of this type is 216 bytes (on a 64-bit architecture).
Definition at line 46 of file uan-mac-cw.h.
TracedCallback signature for enqueue/dequeue of a packet.
[in] | packet | The Packet being received. |
[in] | proto | The protocol number. |
Definition at line 106 of file uan-mac-cw.h.
|
private |
Enum defining possible Phy states.
Enumerator | |
---|---|
IDLE | Idle state. |
CCABUSY | Channel busy. |
RUNNING | Delay timer running. |
TX | Transmitting. |
Definition at line 110 of file uan-mac-cw.h.
ns3::UanMacCw::UanMacCw | ( | ) |
|
override |
Dummy destructor, DoDispose.
Definition at line 49 of file uan-mac-cw.cc.
|
overridevirtual |
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.
stream | First stream index to use. |
Implements ns3::UanMac.
Definition at line 280 of file uan-mac-cw.cc.
References m_rv, NS_LOG_FUNCTION, and ns3::RandomVariableStream::SetStream().
Attach PHY layer to this MAC.
Some MACs may be designed to work with multiple PHY layers. Others may only work with one.
phy | Phy layer to attach to this MAC. |
Implements ns3::UanMac.
Definition at line 188 of file uan-mac-cw.cc.
References m_phy, ns3::MakeCallback(), PhyRxPacketError(), and PhyRxPacketGood().
|
overridevirtual |
Clears all pointer references.
Implements ns3::UanMac.
Definition at line 54 of file uan-mac-cw.cc.
References ns3::EventId::Cancel(), m_cleared, m_phy, m_pktTx, m_sendEvent, and m_txOngoing.
Referenced by DoDispose().
|
overrideprotectedvirtual |
Destructor implementation.
This method is called by Dispose() or by the Object's destructor, whichever comes first.
Subclasses are expected to implement their real destruction code in an overridden 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::Object.
Definition at line 72 of file uan-mac-cw.cc.
References Clear(), and ns3::Object::DoDispose().
|
private |
End TX state.
Definition at line 288 of file uan-mac-cw.cc.
References CCABUSY, ns3::UanMac::GetAddress(), IDLE, m_phy, m_state, ns3::Now(), NS_ASSERT, NS_FATAL_ERROR, NS_LOG_DEBUG, RUNNING, ns3::Time::S, StartTimer(), and TX.
Referenced by NotifyTxEnd().
|
overridevirtual |
Enqueue packet to be transmitted.
pkt | Packet to be transmitted. |
dest | Destination address. |
protocolNumber | The type of the packet. |
Implements ns3::UanMac.
Definition at line 113 of file uan-mac-cw.cc.
References ns3::Time::As(), CCABUSY, ns3::Mac8Address::ConvertFrom(), ns3::UanMac::GetAddress(), ns3::UanMac::GetTxModeIndex(), ns3::UniformRandomVariable::GetValue(), IDLE, m_cw, m_enqueueLogger, m_phy, m_pktTx, m_pktTxProt, m_rv, m_savedDelayS, m_sendTime, m_slotTime, m_state, m_txOngoing, ns3::Now(), ns3::Simulator::Now(), NS_ASSERT, NS_LOG_DEBUG, RUNNING, ns3::Time::S, ns3::UanHeaderCommon::SetDest(), ns3::UanHeaderCommon::SetProtocolNumber(), ns3::UanHeaderCommon::SetSrc(), ns3::UanHeaderCommon::SetType(), and TX.
|
virtual |
Get the contention window size.
Definition at line 324 of file uan-mac-cw.cc.
References m_cw.
|
virtual |
Get the slot time duration.
Definition at line 330 of file uan-mac-cw.cc.
References m_slotTime.
|
static |
Register this type.
Definition at line 79 of file uan-mac-cw.cc.
References m_cw, m_dequeueLogger, m_enqueueLogger, m_rxLogger, m_slotTime, ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MakeTraceSourceAccessor(), ns3::MakeUintegerAccessor(), ns3::MilliSeconds(), and ns3::TypeId::SetParent().
|
overridevirtual |
Called when UanPhy stops sensing channel is busy.
Implements ns3::UanPhyListener.
Definition at line 245 of file uan-mac-cw.cc.
References CCABUSY, ns3::UanMac::GetAddress(), m_state, ns3::Now(), NS_LOG_DEBUG, RUNNING, ns3::Time::S, and StartTimer().
|
overridevirtual |
Called when UanPhy begins sensing channel is busy.
Implements ns3::UanPhyListener.
Definition at line 233 of file uan-mac-cw.cc.
References CCABUSY, ns3::UanMac::GetAddress(), m_state, ns3::Now(), NS_LOG_DEBUG, RUNNING, ns3::Time::S, and SaveTimer().
|
overridevirtual |
Called when UanPhy finishes receiving packet in error.
Implements ns3::UanPhyListener.
Definition at line 221 of file uan-mac-cw.cc.
References CCABUSY, ns3::UanMac::GetAddress(), m_phy, m_state, ns3::Now(), NS_LOG_DEBUG, RUNNING, ns3::Time::S, and StartTimer().
|
overridevirtual |
Called when UanPhy finishes receiving packet without error.
Implements ns3::UanPhyListener.
Definition at line 209 of file uan-mac-cw.cc.
References CCABUSY, ns3::UanMac::GetAddress(), m_phy, m_state, ns3::Now(), NS_LOG_DEBUG, RUNNING, ns3::Time::S, and StartTimer().
|
overridevirtual |
Called when UanPhy begins receiving packet.
Implements ns3::UanPhyListener.
Definition at line 197 of file uan-mac-cw.cc.
References CCABUSY, ns3::UanMac::GetAddress(), m_state, ns3::Now(), NS_LOG_DEBUG, RUNNING, ns3::Time::S, and SaveTimer().
|
overridevirtual |
Function called when Phy object finishes transmitting packet.
Implements ns3::UanPhyListener.
Definition at line 272 of file uan-mac-cw.cc.
References EndTx(), and m_txOngoing.
|
overridevirtual |
Called when transmission starts from Phy object.
duration | Duration of transmission. |
Implements ns3::UanPhyListener.
Definition at line 257 of file uan-mac-cw.cc.
References CCABUSY, m_state, m_txOngoing, ns3::Now(), NS_ASSERT, NS_LOG_DEBUG, RUNNING, ns3::Time::S, and SaveTimer().
Packet received at lower layer in error.
packet | Packet received in error. |
sinr | SINR of received packet. |
Definition at line 349 of file uan-mac-cw.cc.
Referenced by AttachPhy().
Receive packet from lower layer (passed to PHY as callback).
packet | Packet being received. |
sinr | SINR of received packet. |
mode | Mode of received packet. |
Definition at line 336 of file uan-mac-cw.cc.
References ns3::Mac8Address::ConvertFrom(), ns3::UanMac::GetAddress(), ns3::Mac8Address::GetBroadcast(), ns3::UanHeaderCommon::GetDest(), ns3::UanHeaderCommon::GetProtocolNumber(), ns3::UanHeaderCommon::GetSrc(), and m_forwardUpCb.
Referenced by AttachPhy().
|
private |
Cancel SendEvent and save remaining delay.
Definition at line 354 of file uan-mac-cw.cc.
References ns3::Simulator::Cancel(), ns3::UanMac::GetAddress(), m_pktTx, m_savedDelayS, m_sendEvent, m_sendTime, ns3::Now(), ns3::Simulator::Now(), NS_ASSERT, NS_LOG_DEBUG, and ns3::Time::S.
Referenced by NotifyCcaStart(), NotifyRxStart(), and NotifyTxStart().
|
private |
Send packet on PHY.
Definition at line 383 of file uan-mac-cw.cc.
References ns3::UanMac::GetAddress(), m_phy, m_pktTx, m_pktTxProt, m_savedDelayS, m_sendTime, m_state, ns3::Now(), NS_ASSERT, NS_LOG_DEBUG, RUNNING, ns3::Time::S, ns3::Seconds(), and TX.
Referenced by StartTimer().
|
virtual |
Set the contention window size.
cw | Contention window size. |
Definition at line 312 of file uan-mac-cw.cc.
References m_cw.
|
overridevirtual |
Set the callback to forward packets up to higher layers.
cb | The callback. packet The packet. address The source address. |
Implements ns3::UanMac.
Definition at line 182 of file uan-mac-cw.cc.
References m_forwardUpCb.
|
virtual |
Set the slot time duration.
duration | Slot time duration. |
Definition at line 318 of file uan-mac-cw.cc.
References m_slotTime.
|
private |
Schedule SendPacket after delay.
Definition at line 366 of file uan-mac-cw.cc.
References ns3::Time::As(), ns3::UanMac::GetAddress(), m_savedDelayS, m_sendEvent, m_sendTime, ns3::Now(), ns3::Simulator::Now(), NS_LOG_DEBUG, ns3::Time::S, ns3::Simulator::Schedule(), and SendPacket().
Referenced by EndTx(), NotifyCcaEnd(), NotifyRxEndError(), and NotifyRxEndOk().
|
private |
|
private |
Contention window size.
Definition at line 130 of file uan-mac-cw.h.
Referenced by Enqueue(), GetCw(), GetTypeId(), and SetCw().
|
private |
A packet was passed down to the PHY from the MAC.
Definition at line 127 of file uan-mac-cw.h.
Referenced by GetTypeId().
|
private |
A packet arrived at the MAC for transmission.
Definition at line 125 of file uan-mac-cw.h.
Referenced by Enqueue(), and GetTypeId().
|
private |
Forwarding up callback.
Definition at line 119 of file uan-mac-cw.h.
Referenced by PhyRxPacketGood(), and SetForwardUpCb().
PHY layer attached to this MAC.
Definition at line 121 of file uan-mac-cw.h.
Referenced by AttachPhy(), Clear(), EndTx(), Enqueue(), NotifyRxEndError(), NotifyRxEndOk(), and SendPacket().
Next packet to send.
Definition at line 139 of file uan-mac-cw.h.
Referenced by Clear(), Enqueue(), SaveTimer(), and SendPacket().
|
private |
Next packet protocol number (usage varies by MAC).
Definition at line 141 of file uan-mac-cw.h.
Referenced by Enqueue(), and SendPacket().
|
private |
Provides uniform random variable for contention window.
Definition at line 153 of file uan-mac-cw.h.
Referenced by UanMacCw(), AssignStreams(), and Enqueue().
|
private |
A packet destined for this MAC was received.
Definition at line 123 of file uan-mac-cw.h.
Referenced by GetTypeId().
|
private |
Remaining delay until next send.
Definition at line 137 of file uan-mac-cw.h.
Referenced by Enqueue(), SaveTimer(), SendPacket(), and StartTimer().
|
private |
Scheduled SendPacket event.
Definition at line 143 of file uan-mac-cw.h.
Referenced by Clear(), SaveTimer(), and StartTimer().
|
private |
Time to send next packet.
Definition at line 135 of file uan-mac-cw.h.
Referenced by Enqueue(), SaveTimer(), SendPacket(), and StartTimer().
|
private |
Slot time duration.
Definition at line 131 of file uan-mac-cw.h.
Referenced by Enqueue(), GetSlotTime(), GetTypeId(), and SetSlotTime().
|
private |
Current state.
Definition at line 147 of file uan-mac-cw.h.
Referenced by EndTx(), Enqueue(), NotifyCcaEnd(), NotifyCcaStart(), NotifyRxEndError(), NotifyRxEndOk(), NotifyRxStart(), NotifyTxStart(), and SendPacket().
|
private |
Tx is ongoing.
Definition at line 145 of file uan-mac-cw.h.
Referenced by Clear(), Enqueue(), NotifyTxEnd(), and NotifyTxStart().