A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
ns3::WimaxConnection Class Reference
WiMAX Models

#include <introspected-doxygen.h>

+ Inheritance diagram for ns3::WimaxConnection:

Public Types

typedef std::list< Ptr< const
Packet > > 		FragmentsQueue
 

Public Member Functions

 WimaxConnection (Cid cid, enum Cid::Type type)
 
void ClearFragmentsQueue (void)
 delete all enqueued fragments
 
Ptr< Packet > Dequeue (MacHeaderType::HeaderType packetType=MacHeaderType::HEADER_TYPE_GENERIC)
 dequeue a packet from the queue of the connection More...
 
Ptr< Packet > Dequeue (MacHeaderType::HeaderType packetType, uint32_t availableByte)
 
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
 
const FragmentsQueue GetFragmentsQueue (void) const
 get a queue of received fragments
 
Ptr< WimaxMacQueue > GetQueue (void) const
 
uint8_t GetSchedulingType (void) const
 
ServiceFlow * GetServiceFlow (void) const
 
enum Cid::Type GetType (void) const
 
std::string GetTypeStr (void) const
 
bool HasPackets (void) const
 
bool HasPackets (MacHeaderType::HeaderType packetType) const
 
void SetServiceFlow (ServiceFlow *serviceFlow)
 set the service flow associated to this connection More...
 
- Public Member Functions inherited from ns3::Object
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 
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)
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
 
uint32_t GetReferenceCount (void) const
 
SimpleRefCount & operator= (const SimpleRefCount &o)
 
void Ref (void) const
 
void Unref (void) const
 
- Public Member Functions inherited from ns3::ObjectBase
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::Object
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

Private Member Functions

virtual void DoDispose (void)
 

Private Attributes

Cid m_cid
 
enum Cid::Type m_cidType
 
FragmentsQueue m_fragmentsQueue
 
Ptr< WimaxMacQueue > m_queue
 
ServiceFlow * m_serviceFlow
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoInitialize (void)
 
virtual void NotifyNewAggregate (void)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 

Detailed Description

Config Paths

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

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

Attributes

  • Type: Connection type
    • Set with class: ns3::EnumValue
    • Underlying type: Broadcast|InitialRanging|Basic|Primary|Transport|Multicast|Padding
    • Flags: read
  • TxQueue: Transmit queue
    • Set with class: ns3::PointerValue
    • Underlying type: ns3::Ptr< ns3::WimaxMacQueue >
    • Flags: read

No TraceSources are defined for this type.

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

Member Function Documentation

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

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

Referenced by Ns3WimaxFragmentationTestCase::DoRun().

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

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden 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 78 of file wimax-connection.cc.

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

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

Referenced by Ns3WimaxFragmentationTestCase::DoRun().

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

Referenced by Ns3WimaxFragmentationTestCase::DoRun().

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

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

Referenced by Ns3WimaxFragmentationTestCase::DoRun().

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

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

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

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

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

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

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

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

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

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