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

Class to represent WiMAX connections. More...

#include "wimax-connection.h"

+ Inheritance diagram for ns3::WimaxConnection:
+ Collaboration diagram for ns3::WimaxConnection:

Public Types

typedef std::list< Ptr< const Packet > > FragmentsQueue
 Definition of Fragments Queue data type. More...
 

Public Member Functions

 WimaxConnection (Cid cid, enum Cid::Type type)
 Constructor. More...
 
 ~WimaxConnection (void)
 
void ClearFragmentsQueue (void)
 delete all enqueued fragments More...
 
Ptr< PacketDequeue (MacHeaderType::HeaderType packetType, uint32_t availableByte)
 dequeue a packet from the queue of the connection Dequeue the first packet in the queue if its size is lower than availableByte, the first availableByte of the first packet otherwise More...
 
Ptr< PacketDequeue (MacHeaderType::HeaderType packetType=MacHeaderType::HEADER_TYPE_GENERIC)
 dequeue a packet from the queue of the connection More...
 
bool Enqueue (Ptr< Packet > packet, const MacHeaderType &hdrType, const GenericMacHeader &hdr)
 enqueue a packet in the queue of the connection More...
 
void FragmentEnqueue (Ptr< const Packet > fragment)
 enqueue a received packet (that is a fragment) into the fragments queue More...
 
Cid GetCid (void) const
 Get CID function. More...
 
const FragmentsQueue GetFragmentsQueue (void) const
 get a queue of received fragments More...
 
Ptr< WimaxMacQueueGetQueue (void) const
 
uint8_t GetSchedulingType (void) const
 
ServiceFlowGetServiceFlow (void) const
 
enum Cid::Type GetType (void) const
 Get type function. More...
 
std::string GetTypeStr (void) const
 Get type string. More...
 
bool HasPackets (MacHeaderType::HeaderType packetType) const
 
bool HasPackets (void) const
 
void SetServiceFlow (ServiceFlow *serviceFlow)
 set the service flow associated to this connection 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)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (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...
 
virtual TypeId GetInstanceTypeId (void) const =0
 Get the most derived TypeId for this Object. 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)
 Get the type ID. 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...
 

Private Member Functions

virtual void DoDispose (void)
 Destructor implementation. More...
 

Private Attributes

Cid m_cid
 CID. More...
 
enum Cid::Type m_cidType
 CID type. More...
 
FragmentsQueue m_fragmentsQueue
 fragments queue More...
 
Ptr< WimaxMacQueuem_queue
 queue More...
 
ServiceFlowm_serviceFlow
 service flow More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. 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...
 

Detailed Description

Class to represent WiMAX connections.

Config Paths

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

  • "/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/InitialRangingConnection"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BroadcastConnection"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/BasicConnection"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/PrimaryConnection"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/BasicConnection"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/PrimaryConnection"

Attributes

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 wimax-connection.h.

Member Typedef Documentation

◆ FragmentsQueue

Definition of Fragments Queue data type.

Definition at line 132 of file wimax-connection.h.

Constructor & Destructor Documentation

◆ WimaxConnection()

ns3::WimaxConnection::WimaxConnection ( Cid  cid,
enum Cid::Type  type 
)

Constructor.

Parameters
cidconnection ID
typeCID type

Definition at line 67 of file wimax-connection.cc.

◆ ~WimaxConnection()

ns3::WimaxConnection::~WimaxConnection ( void  )

Definition at line 75 of file wimax-connection.cc.

Member Function Documentation

◆ ClearFragmentsQueue()

void ns3::WimaxConnection::ClearFragmentsQueue ( void  )

delete all enqueued fragments

Definition at line 197 of file wimax-connection.cc.

References m_fragmentsQueue.

Referenced by Ns3WimaxFragmentationTestCase::DoRun().

+ Here is the caller graph for this function:

◆ Dequeue() [1/2]

Ptr< Packet > ns3::WimaxConnection::Dequeue ( MacHeaderType::HeaderType  packetType,
uint32_t  availableByte 
)

dequeue a packet from the queue of the connection Dequeue the first packet in the queue if its size is lower than availableByte, the first availableByte of the first packet otherwise

Parameters
packetTypethe type of the packet to dequeue
availableBytethe number of available bytes
Returns
packet dequeued

Definition at line 136 of file wimax-connection.cc.

References m_queue.

◆ Dequeue() [2/2]

Ptr< Packet > ns3::WimaxConnection::Dequeue ( MacHeaderType::HeaderType  packetType = MacHeaderType::HEADER_TYPE_GENERIC)

dequeue a packet from the queue of the connection

Parameters
packetTypethe type of the packet to dequeue
Returns
packet dequeued

Definition at line 130 of file wimax-connection.cc.

References m_queue.

Referenced by Ns3WimaxFragmentationTestCase::DoRun().

+ Here is the caller graph for this function:

◆ DoDispose()

void ns3::WimaxConnection::DoDispose ( void  )
privatevirtual

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 80 of file wimax-connection.cc.

References m_queue.

◆ Enqueue()

bool ns3::WimaxConnection::Enqueue ( Ptr< Packet packet,
const MacHeaderType hdrType,
const GenericMacHeader hdr 
)

enqueue a packet in the queue of the connection

Parameters
packetthe packet to be enqueued
hdrTypethe header type of the packet
hdrthe header of the packet
Returns
true if successful

Definition at line 123 of file wimax-connection.cc.

References m_queue.

Referenced by Ns3WimaxFragmentationTestCase::DoRun().

+ Here is the caller graph for this function:

◆ FragmentEnqueue()

void ns3::WimaxConnection::FragmentEnqueue ( Ptr< const Packet fragment)

enqueue a received packet (that is a fragment) into the fragments queue

Parameters
fragmentreceived fragment

Definition at line 191 of file wimax-connection.cc.

References m_fragmentsQueue.

Referenced by Ns3WimaxFragmentationTestCase::DoRun().

+ Here is the caller graph for this function:

◆ GetCid()

Cid ns3::WimaxConnection::GetCid ( void  ) const

Get CID function.

Returns
the CID

Definition at line 87 of file wimax-connection.cc.

References m_cid.

Referenced by Ns3WimaxFragmentationTestCase::DoRun().

+ Here is the caller graph for this function:

◆ GetFragmentsQueue()

const WimaxConnection::FragmentsQueue ns3::WimaxConnection::GetFragmentsQueue ( void  ) const

get a queue of received fragments

Returns
the fragments queue

Definition at line 185 of file wimax-connection.cc.

References m_fragmentsQueue.

Referenced by Ns3WimaxFragmentationTestCase::DoRun().

+ Here is the caller graph for this function:

◆ GetQueue()

Ptr< WimaxMacQueue > ns3::WimaxConnection::GetQueue ( void  ) const
Returns
the queue of the connection

Definition at line 99 of file wimax-connection.cc.

References m_queue.

Referenced by Ns3WimaxFragmentationTestCase::DoRun(), and GetTypeId().

+ Here is the caller graph for this function:

◆ GetSchedulingType()

uint8_t ns3::WimaxConnection::GetSchedulingType ( void  ) const
Returns
the scheduling type of this connection

Definition at line 117 of file wimax-connection.cc.

References ns3::ServiceFlow::GetSchedulingType(), and m_serviceFlow.

+ Here is the call graph for this function:

◆ GetServiceFlow()

ServiceFlow * ns3::WimaxConnection::GetServiceFlow ( void  ) const
Returns
the service flow associated to this connection

Definition at line 111 of file wimax-connection.cc.

References m_serviceFlow.

◆ GetType()

enum Cid::Type ns3::WimaxConnection::GetType ( void  ) const

Get type function.

Returns
the type

Definition at line 93 of file wimax-connection.cc.

References m_cidType.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetTypeId()

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

◆ GetTypeStr()

std::string ns3::WimaxConnection::GetTypeStr ( void  ) const

◆ HasPackets() [1/2]

bool ns3::WimaxConnection::HasPackets ( MacHeaderType::HeaderType  packetType) const
Returns
true if the connection has at least one packet of type packetType in its queue, false otherwise
Parameters
packetTypetype of packet to check in the queue
Returns
true if packets available

Definition at line 148 of file wimax-connection.cc.

References m_queue.

◆ HasPackets() [2/2]

bool ns3::WimaxConnection::HasPackets ( void  ) const
Returns
true if the connection has at least one packet in its queue, false otherwise

Definition at line 142 of file wimax-connection.cc.

References m_queue.

◆ SetServiceFlow()

void ns3::WimaxConnection::SetServiceFlow ( ServiceFlow serviceFlow)

set the service flow associated to this connection

Parameters
serviceFlowThe service flow to be associated to this connection

Definition at line 105 of file wimax-connection.cc.

References m_serviceFlow.

Member Data Documentation

◆ m_cid

Cid ns3::WimaxConnection::m_cid
private

CID.

Definition at line 151 of file wimax-connection.h.

Referenced by GetCid().

◆ m_cidType

enum Cid::Type ns3::WimaxConnection::m_cidType
private

CID type.

Definition at line 152 of file wimax-connection.h.

Referenced by GetType(), and GetTypeStr().

◆ m_fragmentsQueue

FragmentsQueue ns3::WimaxConnection::m_fragmentsQueue
private

fragments queue

Definition at line 157 of file wimax-connection.h.

Referenced by ClearFragmentsQueue(), FragmentEnqueue(), and GetFragmentsQueue().

◆ m_queue

Ptr<WimaxMacQueue> ns3::WimaxConnection::m_queue
private

queue

Definition at line 153 of file wimax-connection.h.

Referenced by Dequeue(), DoDispose(), Enqueue(), GetQueue(), and HasPackets().

◆ m_serviceFlow

ServiceFlow* ns3::WimaxConnection::m_serviceFlow
private

service flow

Definition at line 154 of file wimax-connection.h.

Referenced by GetSchedulingType(), GetServiceFlow(), and SetServiceFlow().


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