A CoDel packet queue disc. More...

#include "codel-queue-disc.h"

Inheritance diagram for ns3::CoDelQueueDisc:

Collaboration diagram for ns3::CoDelQueueDisc:

Public Member Functions
	CoDelQueueDisc ()
	CoDelQueueDisc Constructor. More...

virtual	~CoDelQueueDisc ()

uint32_t	GetDropCount (void)
	Get the number of packets dropped according to CoDel algorithm. More...

uint32_t	GetDropNext (void)
	Get the time for next packet drop while in the dropping state. More...

uint32_t	GetDropOverLimit (void)
	Get the number of packets dropped when packets arrive at a full queue and cannot be enqueued. More...

Time	GetInterval (void)
	Get the interval. More...

Queue::QueueMode	GetMode (void)
	Get the encapsulation mode of this device. More...

uint32_t	GetQueueSize (void)
	Get the current value of the queue in bytes or packets. More...

Time	GetTarget (void)
	Get the target queue delay. More...

void	SetMode (Queue::QueueMode mode)
	Set the operating mode of this device. More...

Public Member Functions inherited from ns3::QueueDisc
	QueueDisc ()

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

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

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

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. More...

Ptr< QueueDiscItem >	Dequeue (void)
	Request the queue discipline to extract a packet. More...

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

Ptr< Queue >	GetInternalQueue (uint32_t i) const
	Get the i-th internal queue. More...

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

Ptr< NetDevice >	GetNetDevice (void) const
	Get the NetDevice on which this queue discipline is installed. More...

uint32_t	GetNInternalQueues (void) const
	Get the number of internal queues. More...

uint32_t	GetNPacketFilters (void) const
	Get the number of packet filters. More...

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

uint32_t	GetNQueueDiscClasses (void) const
	Get the number of queue disc classes. More...

Ptr< PacketFilter >	GetPacketFilter (uint32_t i) const
	Get the i-th packet filter. More...

Ptr< QueueDiscClass >	GetQueueDiscClass (uint32_t i) const
	Get the i-th queue disc class. More...

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

uint32_t	GetTotalDroppedBytes (void) const
	Get the total amount of dropped bytes. More...

uint32_t	GetTotalDroppedPackets (void) const
	Get the total number of dropped packets. More...

uint32_t	GetTotalReceivedBytes (void) const
	Get the total amount of received bytes. More...

uint32_t	GetTotalReceivedPackets (void) const
	Get the total number of received packets. More...

uint32_t	GetTotalRequeuedBytes (void) const
	Get the total amount of requeued bytes. More...

uint32_t	GetTotalRequeuedPackets (void) const
	Get the total number of requeued packets. More...

WakeMode	GetWakeMode (void)
	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. More...

Ptr< const QueueDiscItem >	Peek (void) const
	Get a copy of the next packet the queue discipline will extract, without actually extracting the packet. More...

void	Run (void)
	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. More...

void	SetNetDevice (Ptr< NetDevice > device)
	Set the NetDevice on which this queue discipline is installed. More...

virtual void	SetParentDropCallback (ParentDropCallback cb)
	Set the parent drop callback. More...

virtual void	SetQuota (const uint32_t quota)
	Set the maximum number of dequeue operations following a packet enqueue. 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
	Implement the GetInstanceTypeId method defined in ObjectBase. More...

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

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId. 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 ()
	Constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

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

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. 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::QueueDisc
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::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. More...

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

Private Member Functions
virtual bool	CheckConfig (void)
	Check whether the current configuration is correct. More...

bool	CoDelTimeAfter (uint32_t a, uint32_t b)
	Check if CoDel time a is successive to b. More...

bool	CoDelTimeAfterEq (uint32_t a, uint32_t b)
	Check if CoDel time a is successive or equal to b. More...

bool	CoDelTimeBefore (uint32_t a, uint32_t b)
	Check if CoDel time a is preceding b. More...

bool	CoDelTimeBeforeEq (uint32_t a, uint32_t b)
	Check if CoDel time a is preceding or equal to b. More...

uint32_t	ControlLaw (uint32_t t)
	Determine the time for next drop CoDel control law is t + m_interval/sqrt(m_count). More...

virtual Ptr< QueueDiscItem >	DoDequeue (void)
	Remove a packet from queue based on the current state If we are in dropping state, check if we could leave the dropping state or if we should perform next drop If we are not currently in dropping state, check if we need to enter the state and drop the first packet. More...

virtual bool	DoEnqueue (Ptr< QueueDiscItem > item)
	Add a packet to the queue. More...

virtual Ptr< const QueueDiscItem >	DoPeek (void) const
	This function returns a copy of the next packet the queue disc will extract. More...

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

void	NewtonStep (void)
	Calculate the reciprocal square root of m_count by using Newton's method http://en.wikipedia.org/wiki/Methods_of_computing_square_roots#Iterative_methods_for_reciprocal_square_roots m_recInvSqrt (new) = (m_recInvSqrt (old) / 2) * (3 - m_count * m_recInvSqrt^2) More...

bool	OkToDrop (Ptr< Packet > p, uint32_t now)
	Determine whether a packet is OK to be dropped. More...

uint32_t	Time2CoDel (Time t)
	returned unsigned 32-bit integer representation of the input Time object units are microseconds More...

Private Attributes
TracedValue< uint32_t >	m_count
	Number of packets dropped since entering drop state. More...

TracedValue< uint32_t >	m_dropCount
	Number of dropped packets according CoDel algorithm. More...

TracedValue< uint32_t >	m_dropNext
	Time to drop next packet. More...

uint32_t	m_dropOverLimit
	The number of packets dropped due to full queue. More...

TracedValue< bool >	m_dropping
	True if in dropping state. More...

uint32_t	m_firstAboveTime
	Time to declare sojourn time above target. More...

Time	m_interval
	100 ms sliding minimum time window width More...

TracedValue< uint32_t >	m_lastCount
	Last number of packets dropped since entering drop state. More...

uint32_t	m_maxBytes
	Max # of bytes accepted by the queue. More...

uint32_t	m_maxPackets
	Max # of packets accepted by the queue. More...

uint32_t	m_minBytes
	Minimum bytes in queue to allow a packet drop. More...

Queue::QueueMode	m_mode
	The operating mode (Bytes or packets) More...

uint16_t	m_recInvSqrt
	Reciprocal inverse square root. More...

TracedValue< Time >	m_sojourn
	Time in queue. More...

uint32_t	m_state1
	Number of times packet sojourn goes above target for interval. More...

uint32_t	m_state2
	Number of times we perform next drop while in dropping state. More...

uint32_t	m_state3
	Number of times we enter drop state and drop the fist packet. More...

uint32_t	m_states
	Total number of times we are in state 1, state 2, or state 3. More...

Time	m_target
	5 ms target queue delay More...

Additional Inherited Members
Public Types inherited from ns3::QueueDisc
typedef Callback< void, Ptr< QueueItem > >	ParentDropCallback
	Callback invoked by a child queue disc to notify the parent of a packet drop. More...

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...

Protected Member Functions inherited from ns3::QueueDisc
virtual void	DoDispose (void)
	Dispose of the object. More...

virtual void	DoInitialize (void)
	Check whether the configuration is correct and initialize parameters. More...

void	Drop (Ptr< QueueItem > item)
	Drop a packet. More...

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

Detailed Description

A CoDel packet queue disc.

Introspection did not find any typical Config paths.

Attributes

Mode: Whether to use Bytes (see MaxBytes) or Packets (see MaxPackets) as the maximum queue size metric.
- Set with class: ns3::EnumValue
- Underlying type:
- Initial value: QUEUE_MODE_BYTES
- Flags: construct write
MaxPackets: The maximum number of packets accepted by this CoDelQueueDisc.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 1000
- Flags: construct write read
MaxBytes: The maximum number of bytes accepted by this CoDelQueueDisc.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 1500000
- Flags: construct write read
MinBytes: The CoDel algorithm minbytes parameter.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 1500
- Flags: construct write read
Interval: The CoDel algorithm interval
- Set with class: ns3::TimeValue
- Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: 100ms
- Flags: construct write read
Target: The CoDel algorithm target queue delay
- Set with class: ns3::TimeValue
- Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: 5ms
- Flags: construct write read

Attributes defined in parent class ns3::QueueDisc

Quota: The maximum number of packets dequeued in a qdisc run
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 64
- Flags: construct write read
InternalQueueList: The list of internal queues.
- Set with class: ns3::ObjectPtrContainerValue
- Underlying type: ns3::Ptr< ns3::Queue>
- Flags: read
PacketFilterList: The list of packet filters.
- Set with class: ns3::ObjectPtrContainerValue
- Underlying type: ns3::Ptr< ns3::PacketFilter>
- Flags: read
QueueDiscClassList: The list of queue disc classes.
- Set with class: ns3::ObjectPtrContainerValue
- Underlying type: ns3::Ptr< ns3::QueueDiscClass>
- Flags: read

TraceSources

Count: CoDel count
Callback signature: ns3::TracedValueCallback::Uint32
DropCount: CoDel drop count
Callback signature: ns3::TracedValueCallback::Uint32
LastCount: CoDel lastcount
Callback signature: ns3::TracedValueCallback::Uint32
DropState: Dropping state
Callback signature: ns3::TracedValueCallback::Bool
Sojourn: Time in the queue
Callback signature: ns3::Time::TracedValueCallback
DropNext: Time until next packet drop
Callback signature: ns3::TracedValueCallback::Uint32

TraceSources defined in parent class ns3::QueueDisc

Enqueue: Enqueue a packet in the queue disc
Callback signature: ns3::QueueItem::TracedCallback
Dequeue: Dequeue a packet from the queue disc
Callback signature: ns3::QueueItem::TracedCallback
Requeue: Requeue a packet in the queue disc
Callback signature: ns3::QueueItem::TracedCallback
Drop: Drop a packet stored in the queue disc
Callback signature: ns3::QueueItem::TracedCallback
PacketsInQueue: Number of packets currently stored in the queue disc
Callback signature: ns3::TracedValueCallback::Uint32
BytesInQueue: Number of bytes currently stored in the queue disc
Callback signature: ns3::TracedValueCallback::Uint32

Size of this type is 496 bytes (on a 64-bit architecture).

Definition at line 62 of file codel-queue-disc.h.

Constructor & Destructor Documentation

ns3::CoDelQueueDisc::CoDelQueueDisc ( )

CoDelQueueDisc Constructor.

Creates a CoDel queue

Definition at line 215 of file codel-queue-disc.cc.

References NS_LOG_FUNCTION.

ns3::CoDelQueueDisc::~CoDelQueueDisc ( )

virtual

Definition at line 235 of file codel-queue-disc.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

bool ns3::CoDelQueueDisc::CheckConfig ( void )

privatevirtual

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.

Returns: true if the configuration is correct, false otherwise

Implements ns3::QueueDisc.

Definition at line 591 of file codel-queue-disc.cc.

References ns3::QueueDisc::AddInternalQueue(), ns3::QueueDisc::GetInternalQueue(), GetMode(), ns3::QueueDisc::GetNInternalQueues(), ns3::QueueDisc::GetNPacketFilters(), ns3::QueueDisc::GetNQueueDiscClasses(), m_maxBytes, m_maxPackets, m_mode, NS_LOG_ERROR, NS_LOG_FUNCTION, ns3::Queue::QUEUE_MODE_BYTES, and ns3::Queue::QUEUE_MODE_PACKETS.

Here is the call graph for this function:

bool ns3::CoDelQueueDisc::CoDelTimeAfter	(	uint32_t	a,
		uint32_t	b
	)

private

Check if CoDel time a is successive to b.

Parameters

a	left operand
b	right operand

Returns: true if a is greater than b

Definition at line 561 of file codel-queue-disc.cc.

Referenced by OkToDrop().

Here is the caller graph for this function:

bool ns3::CoDelQueueDisc::CoDelTimeAfterEq	(	uint32_t	a,
		uint32_t	b
	)

private

Check if CoDel time a is successive or equal to b.

Parameters

a	left operand
b	right operand

Returns: true if a is greater than or equal to b

Definition at line 567 of file codel-queue-disc.cc.

Referenced by DoDequeue().

Here is the caller graph for this function:

bool ns3::CoDelQueueDisc::CoDelTimeBefore	(	uint32_t	a,
		uint32_t	b
	)

private

Check if CoDel time a is preceding b.

Parameters

a	left operand
b	right operand

Returns: true if a is less than to b

Definition at line 573 of file codel-queue-disc.cc.

Referenced by DoDequeue(), and OkToDrop().

Here is the caller graph for this function:

bool ns3::CoDelQueueDisc::CoDelTimeBeforeEq	(	uint32_t	a,
		uint32_t	b
	)

private

Check if CoDel time a is preceding or equal to b.

Parameters

a	left operand
b	right operand

Returns: true if a is less than or equal to b

Definition at line 579 of file codel-queue-disc.cc.

uint32_t ns3::CoDelQueueDisc::ControlLaw ( uint32_t t )

private

Determine the time for next drop CoDel control law is t + m_interval/sqrt(m_count).

Here, we use m_recInvSqrt calculated by Newton's method in NewtonStep() to avoid both sqrt() and divide operations

Parameters

t	Current next drop time

Returns: The new next drop time:

Definition at line 254 of file codel-queue-disc.cc.

References m_interval, m_recInvSqrt, NS_LOG_FUNCTION, REC_INV_SQRT_SHIFT, ns3::ReciprocalDivide(), and Time2CoDel().

Referenced by DoDequeue(), and CoDelQueueDiscControlLawTest::DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

Ptr< QueueDiscItem > ns3::CoDelQueueDisc::DoDequeue ( void )

privatevirtual

Remove a packet from queue based on the current state If we are in dropping state, check if we could leave the dropping state or if we should perform next drop If we are not currently in dropping state, check if we need to enter the state and drop the first packet.

Returns: The packet that is examined

Implements ns3::QueueDisc.

Definition at line 354 of file codel-queue-disc.cc.

References ns3::CoDelGetTime(), CoDelTimeAfterEq(), CoDelTimeBefore(), ControlLaw(), ns3::QueueDisc::Drop(), ns3::QueueDisc::GetInternalQueue(), ns3::QueueDisc::GetNBytes(), ns3::QueueDisc::GetNPackets(), m_count, m_dropCount, m_dropNext, m_dropping, m_firstAboveTime, m_interval, m_lastCount, m_recInvSqrt, m_state2, m_state3, m_states, NewtonStep(), NS_LOG_FUNCTION, NS_LOG_LOGIC, OkToDrop(), REC_INV_SQRT_SHIFT, and Time2CoDel().

Here is the call graph for this function:

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

privatevirtual

Add a packet to the queue.

Parameters

item	The item to be added

Returns: True if the packet can be added, False if the packet is dropped due to full queue

Implements ns3::QueueDisc.

Definition at line 275 of file codel-queue-disc.cc.

References ns3::Packet::AddPacketTag(), ns3::QueueDisc::Drop(), ns3::QueueDisc::GetInternalQueue(), ns3::QueueDisc::GetNBytes(), ns3::QueueDisc::GetNPackets(), m_dropOverLimit, m_maxBytes, m_maxPackets, m_mode, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::Queue::QUEUE_MODE_BYTES, and ns3::Queue::QUEUE_MODE_PACKETS.

Here is the call graph for this function:

Ptr< const QueueDiscItem > ns3::CoDelQueueDisc::DoPeek ( void ) const

privatevirtual

This function returns a copy of the next packet the queue disc will extract.

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

Implements ns3::QueueDisc.

Definition at line 542 of file codel-queue-disc.cc.

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

Here is the call graph for this function:

uint32_t ns3::CoDelQueueDisc::GetDropCount ( void )

Get the number of packets dropped according to CoDel algorithm.

Returns: The number of dropped packets

Definition at line 518 of file codel-queue-disc.cc.

References m_dropCount.

Referenced by CoDelQueueDiscBasicDrop::Dequeue(), and CoDelQueueDiscBasicEnqueueDequeue::DoRun().

Here is the caller graph for this function:

uint32_t ns3::CoDelQueueDisc::GetDropNext ( void )

Get the time for next packet drop while in the dropping state.

Returns: The time for next packet drop

Definition at line 536 of file codel-queue-disc.cc.

References m_dropNext.

Referenced by CoDelQueueDiscBasicDrop::Dequeue().

Here is the caller graph for this function:

uint32_t ns3::CoDelQueueDisc::GetDropOverLimit ( void )

Get the number of packets dropped when packets arrive at a full queue and cannot be enqueued.

Returns: The number of dropped packets

Definition at line 512 of file codel-queue-disc.cc.

References m_dropOverLimit.

Referenced by CoDelQueueDiscBasicEnqueueDequeue::DoRun(), and CoDelQueueDiscBasicOverflow::DoRun().

Here is the caller graph for this function:

Time ns3::CoDelQueueDisc::GetInterval ( void )

Get the interval.

Returns: The interval

Definition at line 530 of file codel-queue-disc.cc.

References m_interval.

Referenced by CoDelQueueDiscBasicDrop::Dequeue(), and CoDelQueueDiscBasicDrop::DoRun().

Here is the caller graph for this function:

Queue::QueueMode ns3::CoDelQueueDisc::GetMode ( void )

Get the encapsulation mode of this device.

Returns: The encapsulation mode of this device.

Definition at line 268 of file codel-queue-disc.cc.

References m_mode, and NS_LOG_FUNCTION.

Referenced by CheckConfig(), CoDelQueueDiscBasicEnqueueDequeue::DoRun(), CoDelQueueDiscBasicOverflow::DoRun(), CoDelQueueDiscBasicDrop::DoRun(), GetQueueSize(), CoDelQueueDiscBasicEnqueueDequeue::QueueTestSize(), CoDelQueueDiscBasicOverflow::QueueTestSize(), and CoDelQueueDiscBasicDrop::QueueTestSize().

Here is the caller graph for this function:

uint32_t ns3::CoDelQueueDisc::GetQueueSize ( void )

Get the current value of the queue in bytes or packets.

Returns: The queue size in bytes or packets.

Definition at line 494 of file codel-queue-disc.cc.

References ns3::QueueDisc::GetInternalQueue(), GetMode(), NS_ABORT_MSG, NS_LOG_FUNCTION, ns3::Queue::QUEUE_MODE_BYTES, and ns3::Queue::QUEUE_MODE_PACKETS.

Referenced by CoDelQueueDiscBasicDrop::Dequeue(), CoDelQueueDiscBasicDrop::DoRun(), CoDelQueueDiscBasicEnqueueDequeue::QueueTestSize(), CoDelQueueDiscBasicOverflow::QueueTestSize(), and CoDelQueueDiscBasicDrop::QueueTestSize().

Here is the call graph for this function:

Here is the caller graph for this function:

Time ns3::CoDelQueueDisc::GetTarget ( void )

Get the target queue delay.

Returns: The target queue delay

Definition at line 524 of file codel-queue-disc.cc.

References m_target.

Referenced by CoDelQueueDiscBasicDrop::Dequeue(), and CoDelQueueDiscBasicDrop::DoRun().

Here is the caller graph for this function:

TypeId ns3::CoDelQueueDisc::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 149 of file codel-queue-disc.cc.

References DEFAULT_CODEL_LIMIT, m_count, m_dropCount, m_dropNext, m_dropping, m_interval, m_lastCount, m_maxBytes, m_maxPackets, m_minBytes, m_sojourn, m_target, ns3::MakeEnumAccessor(), ns3::MakeEnumChecker(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MakeTraceSourceAccessor(), ns3::MakeUintegerAccessor(), ns3::Queue::QUEUE_MODE_BYTES, ns3::Queue::QUEUE_MODE_PACKETS, SetMode(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

void ns3::CoDelQueueDisc::InitializeParams ( void )

privatevirtual

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

Implements ns3::QueueDisc.

Definition at line 644 of file codel-queue-disc.cc.

References NS_LOG_FUNCTION.

void ns3::CoDelQueueDisc::NewtonStep ( void )

private

Calculate the reciprocal square root of m_count by using Newton's method http://en.wikipedia.org/wiki/Methods_of_computing_square_roots#Iterative_methods_for_reciprocal_square_roots m_recInvSqrt (new) = (m_recInvSqrt (old) / 2) * (3 - m_count * m_recInvSqrt^2)

Definition at line 241 of file codel-queue-disc.cc.

References m_count, m_recInvSqrt, NS_LOG_FUNCTION, and REC_INV_SQRT_SHIFT.

Referenced by DoDequeue(), and CoDelQueueDiscNewtonStepTest::DoRun().

Here is the caller graph for this function:

bool ns3::CoDelQueueDisc::OkToDrop	(	Ptr< Packet >	p,
		uint32_t	now
	)

private

Determine whether a packet is OK to be dropped.

The packet may not be actually dropped (depending on the drop state)

Parameters

p	The packet that is considered
now	The current time represented as 32-bit unsigned integer (us)

Returns: True if it is OK to drop the packet (sojourn time above target for at least interval)

Definition at line 312 of file codel-queue-disc.cc.

References CoDelTimeAfter(), CoDelTimeBefore(), ns3::QueueDisc::GetInternalQueue(), ns3::QueueDisc::GetNBytes(), ns3::Time::GetSeconds(), ns3::CoDelTimestampTag::GetTxTime(), m_firstAboveTime, m_interval, m_minBytes, m_sojourn, m_state1, m_target, ns3::Simulator::Now(), NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, NS_UNUSED, ns3::Packet::RemovePacketTag(), and Time2CoDel().

Referenced by DoDequeue().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::CoDelQueueDisc::SetMode ( Queue::QueueMode mode )

Set the operating mode of this device.

Parameters

mode	The operating mode of this device.

Definition at line 261 of file codel-queue-disc.cc.

References m_mode, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

uint32_t ns3::CoDelQueueDisc::Time2CoDel ( Time t )

private

returned unsigned 32-bit integer representation of the input Time object units are microseconds

Definition at line 585 of file codel-queue-disc.cc.

References ns3::CODEL_SHIFT, and ns3::Time::GetNanoSeconds().

Referenced by CoDelQueueDiscControlLawTest::_codel_control_law(), ControlLaw(), DoDequeue(), and OkToDrop().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

TracedValue<uint32_t> ns3::CoDelQueueDisc::m_count

private

Number of packets dropped since entering drop state.

Definition at line 233 of file codel-queue-disc.h.

Referenced by DoDequeue(), CoDelQueueDiscNewtonStepTest::DoRun(), GetTypeId(), and NewtonStep().

TracedValue<uint32_t> ns3::CoDelQueueDisc::m_dropCount

private

Number of dropped packets according CoDel algorithm.

Definition at line 234 of file codel-queue-disc.h.

Referenced by DoDequeue(), GetDropCount(), and GetTypeId().

TracedValue<uint32_t> ns3::CoDelQueueDisc::m_dropNext

private

Time to drop next packet.

Definition at line 239 of file codel-queue-disc.h.

Referenced by DoDequeue(), GetDropNext(), and GetTypeId().

uint32_t ns3::CoDelQueueDisc::m_dropOverLimit

private

The number of packets dropped due to full queue.

Definition at line 244 of file codel-queue-disc.h.

Referenced by DoEnqueue(), and GetDropOverLimit().

TracedValue<bool> ns3::CoDelQueueDisc::m_dropping

private

True if in dropping state.

Definition at line 236 of file codel-queue-disc.h.

Referenced by DoDequeue(), and GetTypeId().

uint32_t ns3::CoDelQueueDisc::m_firstAboveTime

private

Time to declare sojourn time above target.

Definition at line 238 of file codel-queue-disc.h.

Referenced by DoDequeue(), and OkToDrop().

Time ns3::CoDelQueueDisc::m_interval

private

100 ms sliding minimum time window width

Definition at line 231 of file codel-queue-disc.h.

Referenced by CoDelQueueDiscControlLawTest::_codel_control_law(), ControlLaw(), DoDequeue(), GetInterval(), GetTypeId(), and OkToDrop().

TracedValue<uint32_t> ns3::CoDelQueueDisc::m_lastCount

private

Last number of packets dropped since entering drop state.

Definition at line 235 of file codel-queue-disc.h.

Referenced by DoDequeue(), and GetTypeId().

uint32_t ns3::CoDelQueueDisc::m_maxBytes

private

Max # of bytes accepted by the queue.

Definition at line 229 of file codel-queue-disc.h.

Referenced by CheckConfig(), DoEnqueue(), and GetTypeId().

uint32_t ns3::CoDelQueueDisc::m_maxPackets

private

Max # of packets accepted by the queue.

Definition at line 228 of file codel-queue-disc.h.

Referenced by CheckConfig(), DoEnqueue(), and GetTypeId().

uint32_t ns3::CoDelQueueDisc::m_minBytes

private

Minimum bytes in queue to allow a packet drop.

Definition at line 230 of file codel-queue-disc.h.

Referenced by GetTypeId(), and OkToDrop().

Queue::QueueMode ns3::CoDelQueueDisc::m_mode

private

The operating mode (Bytes or packets)

Definition at line 245 of file codel-queue-disc.h.

Referenced by CheckConfig(), DoEnqueue(), GetMode(), and SetMode().

uint16_t ns3::CoDelQueueDisc::m_recInvSqrt

private

Reciprocal inverse square root.

Definition at line 237 of file codel-queue-disc.h.

Referenced by CoDelQueueDiscControlLawTest::_codel_control_law(), ControlLaw(), DoDequeue(), CoDelQueueDiscNewtonStepTest::DoRun(), and NewtonStep().

TracedValue<Time> ns3::CoDelQueueDisc::m_sojourn

private

Time in queue.

Definition at line 246 of file codel-queue-disc.h.

Referenced by GetTypeId(), and OkToDrop().

uint32_t ns3::CoDelQueueDisc::m_state1

private

Number of times packet sojourn goes above target for interval.

Definition at line 240 of file codel-queue-disc.h.

Referenced by OkToDrop().

uint32_t ns3::CoDelQueueDisc::m_state2

private

Number of times we perform next drop while in dropping state.

Definition at line 241 of file codel-queue-disc.h.

Referenced by DoDequeue().

uint32_t ns3::CoDelQueueDisc::m_state3

private

Number of times we enter drop state and drop the fist packet.

Definition at line 242 of file codel-queue-disc.h.

Referenced by DoDequeue().

uint32_t ns3::CoDelQueueDisc::m_states

private

Total number of times we are in state 1, state 2, or state 3.

Definition at line 243 of file codel-queue-disc.h.

Referenced by DoDequeue().

Time ns3::CoDelQueueDisc::m_target

private

5 ms target queue delay

Definition at line 232 of file codel-queue-disc.h.

Referenced by GetTarget(), GetTypeId(), and OkToDrop().

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

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Attributes

Attributes defined in parent class ns3::QueueDisc

TraceSources

TraceSources defined in parent class ns3::QueueDisc

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation