Class to represent WiMAX connections. More...
#include "wimax-connection.h"
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< Packet > | 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 More... | |
Ptr< Packet > | Dequeue (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< WimaxMacQueue > | GetQueue (void) const |
uint8_t | GetSchedulingType (void) const |
ServiceFlow * | GetServiceFlow (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< Object > | GetObject () 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< Object > | GetObject (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... | |
SimpleRefCount & | operator= ([[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) |
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< WimaxMacQueue > | m_queue |
queue More... | |
ServiceFlow * | m_serviceFlow |
service flow More... | |
Additional Inherited Members | |
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... | |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid (void) |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
Class to represent WiMAX connections.
ns3::WimaxConnection is accessible through the following paths with Config::Set and Config::Connect:
No TraceSources are defined for this type.
Size of this type is 80 bytes (on a 64-bit architecture).
Definition at line 42 of file wimax-connection.h.
typedef std::list<Ptr<const Packet> > ns3::WimaxConnection::FragmentsQueue |
Definition of Fragments Queue data type.
Definition at line 132 of file wimax-connection.h.
Constructor.
cid | connection ID |
type | CID type |
Definition at line 67 of file wimax-connection.cc.
ns3::WimaxConnection::~WimaxConnection | ( | void | ) |
Definition at line 75 of file wimax-connection.cc.
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().
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
packetType | the type of the packet to dequeue |
availableByte | the number of available bytes |
Definition at line 136 of file wimax-connection.cc.
References m_queue.
Ptr< Packet > ns3::WimaxConnection::Dequeue | ( | MacHeaderType::HeaderType | packetType = MacHeaderType::HEADER_TYPE_GENERIC | ) |
dequeue a packet from the queue of the connection
packetType | the type of the packet to dequeue |
Definition at line 130 of file wimax-connection.cc.
References m_queue.
Referenced by Ns3WimaxFragmentationTestCase::DoRun().
|
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.
bool ns3::WimaxConnection::Enqueue | ( | Ptr< Packet > | packet, |
const MacHeaderType & | hdrType, | ||
const GenericMacHeader & | hdr | ||
) |
enqueue a packet in the queue of the connection
packet | the packet to be enqueued |
hdrType | the header type of the packet |
hdr | the header of the packet |
Definition at line 123 of file wimax-connection.cc.
References m_queue.
Referenced by Ns3WimaxFragmentationTestCase::DoRun().
enqueue a received packet (that is a fragment) into the fragments queue
fragment | received fragment |
Definition at line 191 of file wimax-connection.cc.
References m_fragmentsQueue.
Referenced by Ns3WimaxFragmentationTestCase::DoRun().
Cid ns3::WimaxConnection::GetCid | ( | void | ) | const |
Get CID function.
Definition at line 87 of file wimax-connection.cc.
References m_cid.
Referenced by Ns3WimaxFragmentationTestCase::DoRun().
const WimaxConnection::FragmentsQueue ns3::WimaxConnection::GetFragmentsQueue | ( | void | ) | const |
get a queue of received fragments
Definition at line 185 of file wimax-connection.cc.
References m_fragmentsQueue.
Referenced by Ns3WimaxFragmentationTestCase::DoRun().
Ptr< WimaxMacQueue > ns3::WimaxConnection::GetQueue | ( | void | ) | const |
Definition at line 99 of file wimax-connection.cc.
References m_queue.
Referenced by Ns3WimaxFragmentationTestCase::DoRun(), and GetTypeId().
uint8_t ns3::WimaxConnection::GetSchedulingType | ( | void | ) | const |
Definition at line 117 of file wimax-connection.cc.
References ns3::ServiceFlow::GetSchedulingType(), and m_serviceFlow.
ServiceFlow * ns3::WimaxConnection::GetServiceFlow | ( | void | ) | const |
Definition at line 111 of file wimax-connection.cc.
References m_serviceFlow.
enum Cid::Type ns3::WimaxConnection::GetType | ( | void | ) | const |
Get type function.
Definition at line 87 of file wimax-connection.cc.
Referenced by GetTypeId().
|
static |
Get the type ID.
Definition at line 32 of file wimax-connection.cc.
References ns3::Cid::BASIC, ns3::Cid::BROADCAST, GetQueue(), GetType(), ns3::Cid::INITIAL_RANGING, ns3::MakeEnumAccessor(), ns3::MakeEnumChecker(), ns3::MakePointerAccessor(), ns3::Cid::MULTICAST, ns3::Cid::PADDING, ns3::Cid::PRIMARY, ns3::TypeId::SetParent(), and ns3::Cid::TRANSPORT.
std::string ns3::WimaxConnection::GetTypeStr | ( | void | ) | const |
Get type string.
Definition at line 154 of file wimax-connection.cc.
References ns3::Cid::BASIC, ns3::Cid::BROADCAST, ns3::Cid::INITIAL_RANGING, m_cidType, ns3::Cid::MULTICAST, NS_FATAL_ERROR, ns3::Cid::PRIMARY, and ns3::Cid::TRANSPORT.
bool ns3::WimaxConnection::HasPackets | ( | MacHeaderType::HeaderType | packetType | ) | const |
packetType | type of packet to check in the queue |
Definition at line 148 of file wimax-connection.cc.
References m_queue.
bool ns3::WimaxConnection::HasPackets | ( | void | ) | const |
Definition at line 142 of file wimax-connection.cc.
References m_queue.
void ns3::WimaxConnection::SetServiceFlow | ( | ServiceFlow * | serviceFlow | ) |
set the service flow associated to this connection
serviceFlow | The service flow to be associated to this connection |
Definition at line 105 of file wimax-connection.cc.
References m_serviceFlow.
|
private |
|
private |
|
private |
fragments queue
Definition at line 157 of file wimax-connection.h.
Referenced by ClearFragmentsQueue(), FragmentEnqueue(), and GetFragmentsQueue().
|
private |
queue
Definition at line 153 of file wimax-connection.h.
Referenced by Dequeue(), DoDispose(), Enqueue(), GetQueue(), and HasPackets().
|
private |
service flow
Definition at line 154 of file wimax-connection.h.
Referenced by GetSchedulingType(), GetServiceFlow(), and SetServiceFlow().