A Discrete-Event Network Simulator
API
ns3::UanMacAloha Class Reference

ALOHA MAC Protocol, the simplest MAC protocol for wireless networks. More...

#include "uan-mac-aloha.h"

+ Inheritance diagram for ns3::UanMacAloha:
+ Collaboration diagram for ns3::UanMacAloha:

Public Member Functions

 UanMacAloha ()
 Default constructor. More...
 
virtual ~UanMacAloha ()
 Dummy destructor, see DoDispose. More...
 
int64_t AssignStreams (int64_t stream)
 Assign a fixed random variable stream number to the random variables used by this model. More...
 
virtual void AttachPhy (Ptr< UanPhy > phy)
 Attach PHY layer to this MAC. More...
 
virtual void Clear (void)
 Clears all pointer references. More...
 
virtual bool Enqueue (Ptr< Packet > pkt, uint16_t protocolNumber, const Address &dest)
 Enqueue packet to be transmitted. More...
 
virtual void SetForwardUpCb (Callback< void, Ptr< Packet >, uint16_t, const Mac8Address & > cb)
 Set the callback to forward packets up to higher layers. More...
 
- Public Member Functions inherited from ns3::UanMac
 UanMac ()
 Default constructor. More...
 
virtual Address GetAddress (void)
 Get the MAC Address. More...
 
virtual Address GetBroadcast (void) const
 Get the broadcast address. More...
 
uint32_t GetTxModeIndex ()
 Get the Tx mode index (Modulation type). More...
 
virtual void SetAddress (Mac8Address addr)
 Set the address. More...
 
void SetTxModeIndex (uint32_t txModeIndex)
 Set the Tx mode index (Modulation type). More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= ([[maybe_unused]] const SimpleRefCount &o)
 Assignment operator. 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
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::UanMac
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Protected Member Functions

virtual void DoDispose ()
 Destructor implementation. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Private Member Functions

void RxPacketError (Ptr< Packet > pkt, double sinr)
 Packet received at lower layer in error. More...
 
void RxPacketGood (Ptr< Packet > pkt, double sinr, UanTxMode txMode)
 Receive packet from lower layer (passed to PHY as callback). More...
 

Private Attributes

bool m_cleared
 Flag when we've been cleared. More...
 
Callback< void, Ptr< Packet >, uint16_t, const Mac8Address & > m_forUpCb
 Forwarding up callback. More...
 
Ptr< UanPhym_phy
 PHY layer attached to this MAC. More...
 

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

Detailed Description

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)

Config Paths

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

  • "/NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Mac/$ns3::UanMacAloha"

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 43 of file uan-mac-aloha.h.

Constructor & Destructor Documentation

◆ UanMacAloha()

ns3::UanMacAloha::UanMacAloha ( )

Default constructor.

Definition at line 36 of file uan-mac-aloha.cc.

◆ ~UanMacAloha()

ns3::UanMacAloha::~UanMacAloha ( )
virtual

Dummy destructor, see DoDispose.

Definition at line 42 of file uan-mac-aloha.cc.

Member Function Documentation

◆ AssignStreams()

int64_t ns3::UanMacAloha::AssignStreams ( int64_t  stream)
virtual

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.

Parameters
streamFirst stream index to use.
Returns
The number of stream indices assigned by this model.

Implements ns3::UanMac.

Definition at line 137 of file uan-mac-aloha.cc.

References NS_LOG_FUNCTION.

◆ AttachPhy()

void ns3::UanMacAloha::AttachPhy ( Ptr< UanPhy phy)
virtual

Attach PHY layer to this MAC.

Some MACs may be designed to work with multiple PHY layers. Others may only work with one.

Parameters
phyPhy layer to attach to this MAC.

Implements ns3::UanMac.

Definition at line 109 of file uan-mac-aloha.cc.

References m_phy, ns3::MakeCallback(), third::phy, RxPacketError(), and RxPacketGood().

+ Here is the call graph for this function:

◆ Clear()

void ns3::UanMacAloha::Clear ( void  )
virtual

Clears all pointer references.

Implements ns3::UanMac.

Definition at line 47 of file uan-mac-aloha.cc.

References m_cleared, and m_phy.

Referenced by DoDispose().

+ Here is the caller graph for this function:

◆ DoDispose()

void ns3::UanMacAloha::DoDispose ( void  )
protectedvirtual

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 62 of file uan-mac-aloha.cc.

References Clear(), and ns3::Object::DoDispose().

+ Here is the call graph for this function:

◆ Enqueue()

bool ns3::UanMacAloha::Enqueue ( Ptr< Packet pkt,
uint16_t  protocolNumber,
const Address dest 
)
virtual

Enqueue packet to be transmitted.

Parameters
pktPacket to be transmitted.
destDestination address.
protocolNumberThe type of the packet.
Returns
True if packet was successfully enqueued.

Implements ns3::UanMac.

Definition at line 80 of file uan-mac-aloha.cc.

References ns3::Packet::AddHeader(), 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().

+ Here is the call graph for this function:

◆ GetTypeId()

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

Register this type.

Returns
The TypeId.

Definition at line 69 of file uan-mac-aloha.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ RxPacketError()

void ns3::UanMacAloha::RxPacketError ( Ptr< Packet pkt,
double  sinr 
)
private

Packet received at lower layer in error.

Parameters
pktPacket received in error.
sinrSINR of received packet.

Definition at line 131 of file uan-mac-aloha.cc.

References ns3::Mac8Address::ConvertFrom(), ns3::UanMac::GetAddress(), ns3::Simulator::Now(), and NS_LOG_DEBUG.

Referenced by AttachPhy().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ RxPacketGood()

void ns3::UanMacAloha::RxPacketGood ( Ptr< Packet pkt,
double  sinr,
UanTxMode  txMode 
)
private

Receive packet from lower layer (passed to PHY as callback).

Parameters
pktPacket being received.
sinrSINR of received packet.
txModeMode of received packet.

Definition at line 117 of file uan-mac-aloha.cc.

References ns3::UanMac::GetAddress(), ns3::Mac8Address::GetBroadcast(), ns3::UanHeaderCommon::GetDest(), ns3::UanHeaderCommon::GetProtocolNumber(), ns3::UanHeaderCommon::GetSrc(), m_forUpCb, NS_LOG_DEBUG, and ns3::Packet::RemoveHeader().

Referenced by AttachPhy().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SetForwardUpCb()

void ns3::UanMacAloha::SetForwardUpCb ( Callback< void, Ptr< Packet >, uint16_t, const Mac8Address & >  cb)
virtual

Set the callback to forward packets up to higher layers.

Parameters
cbThe callback. packet The packet. address The source address.

Implements ns3::UanMac.

Definition at line 104 of file uan-mac-aloha.cc.

References m_forUpCb.

Member Data Documentation

◆ m_cleared

bool ns3::UanMacAloha::m_cleared
private

Flag when we've been cleared.

Definition at line 70 of file uan-mac-aloha.h.

Referenced by Clear().

◆ m_forUpCb

Callback<void, Ptr<Packet>, uint16_t, const Mac8Address& > ns3::UanMacAloha::m_forUpCb
private

Forwarding up callback.

Definition at line 68 of file uan-mac-aloha.h.

Referenced by RxPacketGood(), and SetForwardUpCb().

◆ m_phy

Ptr<UanPhy> ns3::UanMacAloha::m_phy
private

PHY layer attached to this MAC.

Definition at line 66 of file uan-mac-aloha.h.

Referenced by AttachPhy(), Clear(), and Enqueue().


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