ALOHA MAC Protocol, the simplest MAC protocol for wireless networks. More...
#include "uan-mac-aloha.h"
Public Member Functions | |
UanMacAloha () | |
Default constructor. | |
~UanMacAloha () override | |
Dummy destructor, see 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. | |
void | SetForwardUpCb (Callback< void, Ptr< Packet >, uint16_t, const Mac8Address & > cb) override |
Set the callback to forward packets up to higher layers. | |
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. | |
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 Member Functions | |
void | RxPacketError (Ptr< Packet > pkt, double sinr) |
Packet received at lower layer in error. | |
void | RxPacketGood (Ptr< Packet > pkt, double sinr, UanTxMode txMode) |
Receive packet from lower layer (passed to PHY as callback). | |
Private Attributes | |
bool | m_cleared |
Flag when we've been cleared. | |
Callback< void, Ptr< Packet >, uint16_t, const Mac8Address & > | m_forUpCb |
Forwarding up callback. | |
Ptr< UanPhy > | m_phy |
PHY layer attached to this MAC. | |
Additional Inherited Members | |
Public Types inherited from ns3::UanMac | |
typedef void(* | PacketModeTracedCallback) (Ptr< const Packet > packet, UanTxMode mode) |
TracedCallback signature for packet reception/enqueue/dequeue events. | |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
ALOHA MAC Protocol, the simplest MAC protocol for wireless networks.
Packets enqueued are immediately transmitted. This MAC attaches a UanHeaderCommon to outgoing packets for address information. (The type field is not used)
ns3::UanMacAloha is accessible through the following paths with Config::Set and Config::Connect:
No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 72 bytes (on a 64-bit architecture).
Definition at line 42 of file uan-mac-aloha.h.
ns3::UanMacAloha::UanMacAloha | ( | ) |
Default constructor.
Definition at line 37 of file uan-mac-aloha.cc.
|
override |
Dummy destructor, see DoDispose.
Definition at line 43 of file uan-mac-aloha.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 141 of file uan-mac-aloha.cc.
References NS_LOG_FUNCTION.
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 113 of file uan-mac-aloha.cc.
References m_phy, ns3::MakeCallback(), RxPacketError(), and RxPacketGood().
|
overridevirtual |
Clears all pointer references.
Implements ns3::UanMac.
Definition at line 48 of file uan-mac-aloha.cc.
References m_cleared, and m_phy.
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 63 of file uan-mac-aloha.cc.
References Clear(), and ns3::Object::DoDispose().
|
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 80 of file uan-mac-aloha.cc.
References ns3::Mac8Address::ConvertFrom(), ns3::UanMac::GetAddress(), ns3::UanMac::GetTxModeIndex(), m_phy, ns3::Now(), NS_LOG_DEBUG, ns3::Time::S, ns3::UanHeaderCommon::SetDest(), ns3::UanHeaderCommon::SetProtocolNumber(), ns3::UanHeaderCommon::SetSrc(), and ns3::UanHeaderCommon::SetType().
|
static |
Register this type.
Definition at line 70 of file uan-mac-aloha.cc.
References ns3::TypeId::SetParent().
Packet received at lower layer in error.
pkt | Packet received in error. |
sinr | SINR of received packet. |
Definition at line 134 of file uan-mac-aloha.cc.
References ns3::Mac8Address::ConvertFrom(), ns3::UanMac::GetAddress(), ns3::Simulator::Now(), and NS_LOG_DEBUG.
Referenced by AttachPhy().
Receive packet from lower layer (passed to PHY as callback).
pkt | Packet being received. |
sinr | SINR of received packet. |
txMode | Mode of received packet. |
Definition at line 121 of file uan-mac-aloha.cc.
References ns3::UanMac::GetAddress(), ns3::Mac8Address::GetBroadcast(), ns3::UanHeaderCommon::GetDest(), ns3::UanHeaderCommon::GetProtocolNumber(), ns3::UanHeaderCommon::GetSrc(), m_forUpCb, and NS_LOG_DEBUG.
Referenced by AttachPhy().
|
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 107 of file uan-mac-aloha.cc.
References m_forUpCb.
|
private |
|
private |
Forwarding up callback.
Definition at line 66 of file uan-mac-aloha.h.
Referenced by RxPacketGood(), and SetForwardUpCb().
PHY layer attached to this MAC.
Definition at line 64 of file uan-mac-aloha.h.
Referenced by AttachPhy(), Clear(), and Enqueue().