A TBF packet queue disc. More...

#include "tbf-queue-disc.h"

Inheritance diagram for ns3::TbfQueueDisc:

Collaboration diagram for ns3::TbfQueueDisc:

Public Member Functions
	TbfQueueDisc ()
	TbfQueueDisc Constructor.

	~TbfQueueDisc () override
	Destructor.

uint32_t	GetBurst () const
	Get the size of the first bucket in bytes.

uint32_t	GetFirstBucketTokens () const
	Get the current number of tokens inside the first bucket in bytes.

uint32_t	GetMtu () const
	Get the size of the second bucket in bytes.

DataRate	GetPeakRate () const
	Get the rate of the tokens entering the second bucket.

DataRate	GetRate () const
	Get the rate of the tokens entering the first bucket.

uint32_t	GetSecondBucketTokens () const
	Get the current number of tokens inside the second bucket in bytes.

void	SetBurst (uint32_t burst)
	Set the size of the first bucket in bytes.

void	SetMtu (uint32_t mtu)
	Set the size of the second bucket in bytes.

void	SetPeakRate (DataRate peakRate)
	Set the rate of the tokens entering the second bucket.

void	SetRate (DataRate rate)
	Set the rate of the tokens entering the first bucket.

Public Member Functions inherited from ns3::QueueDisc
	QueueDisc (const QueueDisc &)=delete

	QueueDisc (QueueDiscSizePolicy policy, QueueSizeUnit unit)
	Constructor.

	QueueDisc (QueueDiscSizePolicy policy=QueueDiscSizePolicy::SINGLE_INTERNAL_QUEUE)
	Constructor.

	~QueueDisc () override

void	AddInternalQueue (Ptr< InternalQueue > queue)
	Add an internal queue to the tail of the list of queues.

void	AddPacketFilter (Ptr< PacketFilter > filter)
	Add a packet filter to the tail of the list of filters used to classify packets.

void	AddQueueDiscClass (Ptr< QueueDiscClass > qdClass)
	Add a queue disc class to the tail of the list of classes.

int32_t	Classify (Ptr< QueueDiscItem > item)
	Classify a packet by calling the packet filters, one at a time, until either a filter able to classify the packet is found or all the filters have been processed.

Ptr< QueueDiscItem >	Dequeue ()
	Extract from the queue disc the packet that has been dequeued by calling Peek, if any, or call the private DoDequeue method (which must be implemented by derived classes) to dequeue a packet, otherwise.

bool	Enqueue (Ptr< QueueDiscItem > item)
	Pass a packet to store to the queue discipline.

QueueSize	GetCurrentSize () const
	Get the current size of the queue disc in bytes, if operating in bytes mode, or packets, otherwise.

Ptr< InternalQueue >	GetInternalQueue (std::size_t i) const
	Get the i-th internal queue.

QueueSize	GetMaxSize () const
	Get the maximum size of the queue disc.

uint32_t	GetNBytes () const
	Get the amount of bytes stored by the queue disc.

Ptr< NetDeviceQueueInterface >	GetNetDeviceQueueInterface () const

std::size_t	GetNInternalQueues () const
	Get the number of internal queues.

std::size_t	GetNPacketFilters () const
	Get the number of packet filters.

uint32_t	GetNPackets () const
	Get the number of packets stored by the queue disc.

std::size_t	GetNQueueDiscClasses () const
	Get the number of queue disc classes.

Ptr< PacketFilter >	GetPacketFilter (std::size_t i) const
	Get the i-th packet filter.

Ptr< QueueDiscClass >	GetQueueDiscClass (std::size_t i) const
	Get the i-th queue disc class.

virtual uint32_t	GetQuota () const
	Get the maximum number of dequeue operations following a packet enqueue.

SendCallback	GetSendCallback () const

const Stats &	GetStats ()
	Retrieve all the collected statistics.

virtual WakeMode	GetWakeMode () const
	When setting up the wake callbacks on the netdevice queues, it is necessary to determine which queue disc (the root queue disc or one of its children) should be activated when the netdevice wakes one of its transmission queues.

QueueDisc &	operator= (const QueueDisc &)=delete

Ptr< const QueueDiscItem >	Peek ()
	Get a copy of the next packet the queue discipline will extract.

void	Run ()
	Modelled after the Linux function __qdisc_run (net/sched/sch_generic.c) Dequeues multiple packets, until a quota is exceeded or sending a packet to the device failed.

bool	SetMaxSize (QueueSize size)
	Set the maximum size of the queue disc.

void	SetNetDeviceQueueInterface (Ptr< NetDeviceQueueInterface > ndqi)

virtual void	SetQuota (const uint32_t quota)
	Set the maximum number of dequeue operations following a packet enqueue.

void	SetSendCallback (SendCallback func)

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::QueueDisc
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Protected Member Functions
void	DoDispose () override
	Dispose of the object.

Protected Member Functions inherited from ns3::QueueDisc
void	DoInitialize () override
	Check whether the configuration is correct and initialize parameters.

void	DropAfterDequeue (Ptr< const QueueDiscItem > item, const char *reason)
	Perform the actions required when the queue disc is notified of a packet dropped after dequeue.

void	DropBeforeEnqueue (Ptr< const QueueDiscItem > item, const char *reason)
	Perform the actions required when the queue disc is notified of a packet dropped before enqueue.

bool	Mark (Ptr< QueueDiscItem > item, const char *reason)
	Marks the given packet and, if successful, updates the counters associated with the given reason.

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Private Member Functions
bool	CheckConfig () override
	Check whether the current configuration is correct.

Ptr< QueueDiscItem >	DoDequeue () override
	This function actually extracts a packet from the queue disc.

bool	DoEnqueue (Ptr< QueueDiscItem > item) override
	This function actually enqueues a packet into the queue disc.

void	InitializeParams () override
	Initialize parameters (if any) before the first packet is enqueued.

Private Attributes
TracedValue< uint32_t >	m_btokens
	Current number of tokens in first bucket.

uint32_t	m_burst
	Size of first bucket in bytes.

EventId	m_id
	EventId of the scheduled queue waking event when enough tokens are available.

uint32_t	m_mtu
	Size of second bucket in bytes.

DataRate	m_peakRate
	Rate at which tokens enter the second bucket.

TracedValue< uint32_t >	m_ptokens
	Current number of tokens in second bucket.

DataRate	m_rate
	Rate at which tokens enter the first bucket.

Time	m_timeCheckPoint
	Time check-point.

Additional Inherited Members
Public Types inherited from ns3::QueueDisc
typedef Queue< QueueDiscItem >	InternalQueue
	Internal queues store QueueDiscItem objects.

typedef std::function< void(Ptr< QueueDiscItem >)>	SendCallback
	Callback invoked to send a packet to the receiving object when Run is called.

enum	WakeMode { WAKE_ROOT = 0x00 , WAKE_CHILD = 0x01 }
	Used to determine whether the queue disc itself or its children must be activated when a netdevice wakes a transmission queue. More...

Static Public Attributes inherited from ns3::QueueDisc
static constexpr const char *	CHILD_QUEUE_DISC_DROP
	Packet dropped by a child queue disc.

static constexpr const char *	CHILD_QUEUE_DISC_MARK
	Packet marked by a child queue disc.

static constexpr const char *	INTERNAL_QUEUE_DROP
	Packet dropped by an internal queue.

Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

A TBF packet queue disc.

Definition at line 38 of file tbf-queue-disc.h.

Constructor & Destructor Documentation

◆ TbfQueueDisc()

ns3::TbfQueueDisc::TbfQueueDisc ( )

TbfQueueDisc Constructor.

Create a TBF queue disc

Definition at line 83 of file tbf-queue-disc.cc.

References NS_LOG_FUNCTION.

◆ ~TbfQueueDisc()

ns3::TbfQueueDisc::~TbfQueueDisc ( )

override

Destructor.

Destructor

Definition at line 89 of file tbf-queue-disc.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ CheckConfig()

bool ns3::TbfQueueDisc::CheckConfig ( )

overrideprivatevirtual

Check whether the current configuration is correct.

Default objects (such as internal queues) might be created by this method to ensure the configuration is correct. This method is automatically called at simulation initialization time, and it is called before the InitializeParams () method. It is appropriate to promote parameter initialization to this method if it aids in checking for correct configuration.

See also: QueueDisc::InitializeParams

Returns: true if the configuration is correct, false otherwise

Implements ns3::QueueDisc.

Definition at line 287 of file tbf-queue-disc.cc.

References ns3::QueueDisc::AddQueueDiscClass(), ns3::ObjectFactory::Create(), ns3::CreateObject(), ns3::QueueDisc::GetMaxSize(), ns3::QueueDisc::GetNetDeviceQueueInterface(), ns3::QueueDisc::GetNInternalQueues(), ns3::QueueDisc::GetNPacketFilters(), ns3::QueueDisc::GetNQueueDiscClasses(), m_burst, m_mtu, m_peakRate, m_rate, NS_LOG_ERROR, NS_LOG_FUNCTION, NS_LOG_WARN, and ns3::ObjectFactory::SetTypeId().

Here is the call graph for this function:

◆ DoDequeue()

Ptr< QueueDiscItem > ns3::TbfQueueDisc::DoDequeue ( )

overrideprivatevirtual

This function actually extracts a packet from the queue disc.

Returns: 0 if the operation was not successful; the item otherwise.

Implements ns3::QueueDisc.

Definition at line 188 of file tbf-queue-disc.cc.

References ns3::Time::As(), ns3::DataRate::CalculateBytesTxTime(), ns3::DataRate::GetBitRate(), ns3::QueueDisc::GetNBytes(), ns3::QueueDisc::GetNPackets(), ns3::QueueDisc::GetQueueDiscClass(), ns3::Time::GetSeconds(), ns3::EventId::IsExpired(), m_btokens, m_burst, m_id, m_mtu, m_peakRate, m_ptokens, m_rate, m_timeCheckPoint, ns3::Simulator::Now(), NS_ASSERT_MSG, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_LOGIC, pktSize, ns3::QueueDisc::Run(), ns3::Time::S, and ns3::Simulator::Schedule().

Here is the call graph for this function:

◆ DoDispose()

void ns3::TbfQueueDisc::DoDispose ( )

overrideprotectedvirtual

Dispose of the object.

Reimplemented from ns3::QueueDisc.

Definition at line 95 of file tbf-queue-disc.cc.

References ns3::QueueDisc::DoDispose(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ DoEnqueue()

bool ns3::TbfQueueDisc::DoEnqueue ( Ptr< QueueDiscItem > item )

overrideprivatevirtual

This function actually enqueues a packet into the queue disc.

Parameters

item	item to enqueue

Returns: True if the operation was successful; false otherwise

Implements ns3::QueueDisc.

Definition at line 172 of file tbf-queue-disc.cc.

References ns3::QueueDisc::GetNBytes(), ns3::QueueDisc::GetNPackets(), ns3::QueueDisc::GetQueueDiscClass(), NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Here is the call graph for this function:

◆ GetBurst()

uint32_t ns3::TbfQueueDisc::GetBurst ( ) const

Get the size of the first bucket in bytes.

Returns: The size of the first bucket in bytes.

Definition at line 109 of file tbf-queue-disc.cc.

References m_burst, and NS_LOG_FUNCTION.

◆ GetFirstBucketTokens()

uint32_t ns3::TbfQueueDisc::GetFirstBucketTokens ( ) const

Get the current number of tokens inside the first bucket in bytes.

Returns: The number of first bucket tokens in bytes.

Definition at line 158 of file tbf-queue-disc.cc.

References m_btokens, and NS_LOG_FUNCTION.

◆ GetMtu()

uint32_t ns3::TbfQueueDisc::GetMtu ( ) const

Get the size of the second bucket in bytes.

Returns: The size of the second bucket in bytes.

Definition at line 123 of file tbf-queue-disc.cc.

References m_mtu, and NS_LOG_FUNCTION.

◆ GetPeakRate()

DataRate ns3::TbfQueueDisc::GetPeakRate ( ) const

Get the rate of the tokens entering the second bucket.

Returns: The rate of second bucket tokens.

Definition at line 151 of file tbf-queue-disc.cc.

References m_peakRate, and NS_LOG_FUNCTION.

◆ GetRate()

DataRate ns3::TbfQueueDisc::GetRate ( ) const

Get the rate of the tokens entering the first bucket.

Returns: The rate of first bucket tokens.

Definition at line 137 of file tbf-queue-disc.cc.

References m_rate, and NS_LOG_FUNCTION.

◆ GetSecondBucketTokens()

uint32_t ns3::TbfQueueDisc::GetSecondBucketTokens ( ) const

Get the current number of tokens inside the second bucket in bytes.

Returns: The number of second bucket tokens in bytes.

Definition at line 165 of file tbf-queue-disc.cc.

References m_ptokens, and NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId ns3::TbfQueueDisc::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 37 of file tbf-queue-disc.cc.

References ns3::QueueDisc::GetMaxSize(), m_btokens, m_ptokens, ns3::MakeDataRateAccessor(), ns3::MakeDataRateChecker(), ns3::MakeQueueSizeAccessor(), ns3::MakeQueueSizeChecker(), ns3::MakeTraceSourceAccessor(), ns3::MakeUintegerAccessor(), ns3::MakeUintegerChecker(), SetBurst(), ns3::QueueDisc::SetMaxSize(), SetMtu(), ns3::TypeId::SetParent(), SetPeakRate(), and SetRate().

Here is the call graph for this function:

◆ InitializeParams()

void ns3::TbfQueueDisc::InitializeParams ( )

overrideprivatevirtual

Initialize parameters (if any) before the first packet is enqueued.

This method is automatically called at simulation initialization time, after the CheckConfig() method has been called.

See also: QueueDisc::CheckConfig

Implements ns3::QueueDisc.

Definition at line 367 of file tbf-queue-disc.cc.

References m_btokens, m_burst, m_id, m_mtu, m_ptokens, m_timeCheckPoint, NS_LOG_FUNCTION, and ns3::Seconds().

Here is the call graph for this function:

◆ SetBurst()

void ns3::TbfQueueDisc::SetBurst ( uint32_t burst )

Set the size of the first bucket in bytes.

Parameters

burst The size of first bucket in bytes.

Definition at line 102 of file tbf-queue-disc.cc.

References m_burst, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetMtu()

void ns3::TbfQueueDisc::SetMtu ( uint32_t mtu )

Set the size of the second bucket in bytes.

Parameters

mtu	The size of second bucket in bytes.

Definition at line 116 of file tbf-queue-disc.cc.

References m_mtu, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetPeakRate()

void ns3::TbfQueueDisc::SetPeakRate ( DataRate peakRate )

Set the rate of the tokens entering the second bucket.

Parameters

peakRate The rate of second bucket tokens.

Definition at line 144 of file tbf-queue-disc.cc.

References m_peakRate, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetRate()

void ns3::TbfQueueDisc::SetRate ( DataRate rate )

Set the rate of the tokens entering the first bucket.

Parameters

rate	The rate of first bucket tokens.

Definition at line 130 of file tbf-queue-disc.cc.

References m_rate, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

Member Data Documentation

◆ m_btokens

TracedValue<uint32_t> ns3::TbfQueueDisc::m_btokens

private

Current number of tokens in first bucket.

Definition at line 150 of file tbf-queue-disc.h.

Referenced by DoDequeue(), GetFirstBucketTokens(), GetTypeId(), and InitializeParams().

◆ m_burst

uint32_t ns3::TbfQueueDisc::m_burst

private

Size of first bucket in bytes.

Definition at line 144 of file tbf-queue-disc.h.

Referenced by CheckConfig(), DoDequeue(), GetBurst(), InitializeParams(), and SetBurst().

◆ m_id

EventId ns3::TbfQueueDisc::m_id

private

EventId of the scheduled queue waking event when enough tokens are available.

Definition at line 153 of file tbf-queue-disc.h.

Referenced by DoDequeue(), and InitializeParams().

◆ m_mtu

uint32_t ns3::TbfQueueDisc::m_mtu

private

Size of second bucket in bytes.

Definition at line 145 of file tbf-queue-disc.h.

Referenced by CheckConfig(), DoDequeue(), GetMtu(), InitializeParams(), and SetMtu().

◆ m_peakRate

DataRate ns3::TbfQueueDisc::m_peakRate

private

Rate at which tokens enter the second bucket.

Definition at line 147 of file tbf-queue-disc.h.

Referenced by CheckConfig(), DoDequeue(), GetPeakRate(), and SetPeakRate().

◆ m_ptokens

TracedValue<uint32_t> ns3::TbfQueueDisc::m_ptokens

private

Current number of tokens in second bucket.

Definition at line 151 of file tbf-queue-disc.h.

Referenced by DoDequeue(), GetSecondBucketTokens(), GetTypeId(), and InitializeParams().

◆ m_rate

DataRate ns3::TbfQueueDisc::m_rate

private

Rate at which tokens enter the first bucket.

Definition at line 146 of file tbf-queue-disc.h.

Referenced by CheckConfig(), DoDequeue(), GetRate(), and SetRate().

◆ m_timeCheckPoint

Time ns3::TbfQueueDisc::m_timeCheckPoint

private

Time check-point.

Definition at line 152 of file tbf-queue-disc.h.

Referenced by DoDequeue(), and InitializeParams().

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

src/traffic-control/model/tbf-queue-disc.h
src/traffic-control/model/tbf-queue-disc.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TbfQueueDisc()

◆ ~TbfQueueDisc()

Member Function Documentation

◆ CheckConfig()

◆ DoDequeue()

◆ DoDispose()

◆ DoEnqueue()

◆ GetBurst()

◆ GetFirstBucketTokens()

◆ GetMtu()

◆ GetPeakRate()

◆ GetRate()

◆ GetSecondBucketTokens()

◆ GetTypeId()

◆ InitializeParams()

◆ SetBurst()

◆ SetMtu()

◆ SetPeakRate()

◆ SetRate()

Member Data Documentation

◆ m_btokens

◆ m_burst

◆ m_id

◆ m_mtu

◆ m_peakRate

◆ m_ptokens

◆ m_rate

◆ m_timeCheckPoint