ns3::WimaxConnection Class Reference

Inheritance diagram for ns3::WimaxConnection:

Collaboration diagram for ns3::WimaxConnection:

List of all members.

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

Public Member Functions
	WimaxConnection (Cid cid, enum Cid::Type type)
Cid	GetCid (void) const
enum Cid::Type	GetType (void) const
Ptr< WimaxMacQueue >	GetQueue (void) const
void	SetServiceFlow (ServiceFlow *serviceFlow)
	set the service flow associated to this connection
ServiceFlow *	GetServiceFlow (void) const
uint8_t	GetSchedulingType (void) const
bool	Enqueue (Ptr< Packet > packet, const MacHeaderType &hdrType, const GenericMacHeader &hdr)
	enqueue a packet in the queue of the connection
Ptr< Packet >	Dequeue (MacHeaderType::HeaderType packetType=MacHeaderType::HEADER_TYPE_GENERIC)
	dequeue a packet from the queue of the connection
Ptr< Packet >	Dequeue (MacHeaderType::HeaderType packetType, uint32_t availableByte)
bool	HasPackets (void) const
bool	HasPackets (MacHeaderType::HeaderType packetType) const
std::string	GetTypeStr (void) const
const FragmentsQueue	GetFragmentsQueue (void) const
	get a queue of received fragments
void	FragmentEnqueue (Ptr< const Packet > fragment)
	enqueue a received packet (that is a fragment) into the fragments queue
void	ClearFragmentsQueue (void)
	delete all enqueued fragments
Public Member Functions inherited from ns3::Object
virtual TypeId	GetInstanceTypeId (void) const
template<typename T >
Ptr< T >	GetObject (void) const
template<typename T >
Ptr< T >	GetObject (TypeId tid) const
void	Dispose (void)
void	AggregateObject (Ptr< Object > other)
AggregateIterator	GetAggregateIterator (void) const
void	Start (void)
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount (const SimpleRefCount &o)
SimpleRefCount &	operator= (const SimpleRefCount &o)
void	Ref (void) const
void	Unref (void) const
uint32_t	GetReferenceCount (void) const
Public Member Functions inherited from ns3::ObjectBase
void	SetAttribute (std::string name, const AttributeValue &value)
bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
void	GetAttribute (std::string name, AttributeValue &value) const
bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
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)
	This method returns the TypeId associated to ns3::WimaxConnection.

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
virtual void	NotifyNewAggregate (void)
virtual void	DoStart (void)
	Object (const Object &o)

---

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:

packetType

the type of the packet to dequeue

References ns3::WimaxMacQueue::Dequeue().

Referenced by ns3::BSSchedulerRtps::BSSchedulerRTPSConnection(), and ns3::SSScheduler::Schedule().

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

enqueue a packet in the queue of the connection

Parameters:

packet	the packet to be enqueued
hdrType	the header type of the packet
hdr	the header of the packet

References ns3::WimaxMacQueue::Enqueue().

Referenced by ns3::BaseStationNetDevice::Enqueue(), and ns3::SubscriberStationNetDevice::Enqueue().

void ns3::WimaxConnection::FragmentEnqueue

(

Ptr< const Packet >

fragment

)

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

Parameters:

fragment

received fragment

Ptr< WimaxMacQueue > ns3::WimaxConnection::GetQueue

(

void

)

const

Returns:

the queue of the connection

Referenced by ns3::BSSchedulerRtps::BSSchedulerRTPSConnection(), GetTypeId(), ns3::SSScheduler::Schedule(), and ns3::BSSchedulerRtps::Schedule().

uint8_t ns3::WimaxConnection::GetSchedulingType

(

void

)

const

Returns:

the scheduling type of this connection

Referenced by ns3::SubscriberStationNetDevice::Enqueue().

ServiceFlow * ns3::WimaxConnection::GetServiceFlow

(

void

)

const

Returns:

the service flow associated to this connection

Referenced by ns3::BSSchedulerRtps::BSSchedulerRTPSConnection(), and ns3::SubscriberStationNetDevice::SendBurst().

TypeId ns3::WimaxConnection::GetTypeId ( void  )

static

This method returns the TypeId associated to ns3::WimaxConnection.

This object 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 defined for this type:

• 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 defined for this type.

Reimplemented from ns3::Object.

References GetQueue(), and ns3::TypeId::SetParent().

bool ns3::WimaxConnection::HasPackets

(

void

)

const

Returns:

true if the connection has at least one packet in its queue, false otherwise

Referenced by ns3::SSScheduler::Schedule().

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:

packetType

type of packet to check in the queue

void ns3::WimaxConnection::SetServiceFlow

(

ServiceFlow *

serviceFlow

)

set the service flow associated to this connection

Parameters:

serviceFlow

The service flow to be associated to this connection

Referenced by ns3::BsServiceFlowManager::ProcessDsaReq().

---

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

• src/wimax/model/wimax-connection.h
• doc/introspected-doxygen.h
• src/wimax/model/wimax-connection.cc