A Discrete-Event Network Simulator
API
ns3::RedQueueDisc Class Reference

A RED packet queue disc. More...

#include "red-queue-disc.h"

+ Inheritance diagram for ns3::RedQueueDisc:
+ Collaboration diagram for ns3::RedQueueDisc:

Classes

struct  Stats
 Stats. More...
 

Public Types

enum  { DTYPE_NONE, DTYPE_FORCED, DTYPE_UNFORCED }
 Drop types. More...
 
- 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...
 

Public Member Functions

 RedQueueDisc ()
 RedQueueDisc Constructor. More...
 
virtual ~RedQueueDisc ()
 Destructor. More...
 
int64_t AssignStreams (int64_t stream)
 Assign a fixed random variable stream number to the random variables used by this model. More...
 
double GetAredAlpha (void)
 Get the alpha value to adapt m_curMaxP. More...
 
double GetAredBeta (void)
 Get the beta value to adapt m_curMaxP. More...
 
Queue::QueueMode GetMode (void)
 Get the encapsulation mode of this queue. More...
 
uint32_t GetQueueSize (void)
 Get the current value of the queue in bytes or packets. More...
 
Stats GetStats ()
 Get the RED statistics after running. More...
 
void SetAredAlpha (double alpha)
 Set the alpha value to adapt m_curMaxP. More...
 
void SetAredBeta (double beta)
 Set the beta value to adapt m_curMaxP. More...
 
void SetMode (Queue::QueueMode mode)
 Set the operating mode of this queue. More...
 
void SetQueueLimit (uint32_t lim)
 Set the limit of the queue. More...
 
void SetTh (double minTh, double maxTh)
 Set the thresh limits of RED. 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< QueueDiscItemDequeue (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< QueueGetInternalQueue (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< NetDeviceGetNetDevice (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< PacketFilterGetPacketFilter (uint32_t i) const
 Get the i-th packet filter. More...
 
Ptr< QueueDiscClassGetQueueDiscClass (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 QueueDiscItemPeek (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...
 
SimpleRefCountoperator= (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...
 

Protected Member Functions

virtual void DoDispose (void)
 Dispose of the object. More...
 
- Protected Member Functions inherited from ns3::QueueDisc
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...
 

Private Member Functions

double CalculatePNew (double qAvg, double, bool gentle, double vA, double vB, double vC, double vD, double maxP)
 Returns a probability using these function parameters for the DropEarly function. More...
 
virtual bool CheckConfig (void)
 Check whether the current configuration is correct. More...
 
virtual Ptr< QueueDiscItemDoDequeue (void)
 This function actually extracts a packet from the queue disc. More...
 
virtual bool DoEnqueue (Ptr< QueueDiscItem > item)
 This function actually enqueues a packet into the queue disc. More...
 
virtual Ptr< const QueueDiscItemDoPeek (void) const
 This function returns a copy of the next packet the queue disc will extract. More...
 
uint32_t DropEarly (Ptr< QueueDiscItem > item, uint32_t qSize)
 Check if a packet needs to be dropped due to probability mark. More...
 
double Estimator (uint32_t nQueued, uint32_t m, double qAvg, double qW)
 Compute the average queue size. More...
 
virtual void InitializeParams (void)
 Initialize the queue parameters. More...
 
double ModifyP (double p, uint32_t count, uint32_t countBytes, uint32_t meanPktSize, bool wait, uint32_t size)
 Returns a probability using these function parameters for the DropEarly function. More...
 
void UpdateMaxP (double newAve, Time now)
 Update m_curMaxP. More...
 

Private Attributes

double m_alpha
 Increment parameter for m_curMaxP in ARED. More...
 
double m_beta
 Decrement parameter for m_curMaxP in ARED. More...
 
double m_bottom
 Lower bound for m_curMaxP in ARED. More...
 
uint32_t m_cautious
 0 for default RED 1 experimental (see red-queue.cc) 2 experimental (see red-queue.cc) 3 use Idle packet size in the ptc More...
 
uint32_t m_count
 Number of packets since last random number generation. More...
 
uint32_t m_countBytes
 Number of bytes since last drop. More...
 
double m_curMaxP
 Current max_p. More...
 
uint32_t m_idle
 0/1 idle status More...
 
uint32_t m_idlePktSize
 Avg pkt size used during idle times. More...
 
Time m_idleTime
 Start of current idle period. More...
 
Time m_interval
 Time interval to update m_curMaxP. More...
 
bool m_isAdaptMaxP
 True to adapt m_curMaxP. More...
 
bool m_isARED
 True to enable Adaptive RED. More...
 
bool m_isGentle
 True to increases dropping prob. More...
 
bool m_isNs1Compat
 Ns-1 compatibility. More...
 
bool m_isWait
 True for waiting between dropped packets. More...
 
Time m_lastSet
 Last time m_curMaxP was updated. More...
 
DataRate m_linkBandwidth
 Link bandwidth. More...
 
Time m_linkDelay
 Link delay. More...
 
double m_lInterm
 The max probability of dropping a packet. More...
 
double m_maxTh
 Max avg length threshold (bytes), should be >= 2*minTh. More...
 
uint32_t m_meanPktSize
 Avg pkt size. More...
 
double m_minTh
 Min avg length threshold (bytes) More...
 
Queue::QueueMode m_mode
 Mode (Bytes or packets) More...
 
uint32_t m_old
 0 when average queue first exceeds threshold More...
 
double m_ptc
 packet time constant in packets/second More...
 
double m_qAvg
 Average queue length. More...
 
uint32_t m_queueLimit
 Queue limit in bytes / packets. More...
 
double m_qW
 Queue weight given to cur queue size sample. More...
 
Time m_rtt
 Rtt to be considered while automatically setting m_bottom in ARED. More...
 
Stats m_stats
 RED statistics. More...
 
Time m_targetDelay
 Target average queuing delay in ARED. More...
 
double m_top
 Upper bound for m_curMaxP in ARED. More...
 
Ptr< UniformRandomVariablem_uv
 rng stream More...
 
double m_vA
 1.0 / (m_maxTh - m_minTh) More...
 
double m_vB
 -m_minTh / (m_maxTh - m_minTh) More...
 
double m_vC
 (1.0 - m_curMaxP) / m_maxTh - used in "gentle" mode More...
 
double m_vD
 2.0 * m_curMaxP - 1.0 - used in "gentle" mode More...
 
double m_vProb
 Prob. More...
 
double m_vProb1
 Prob. More...
 

Additional Inherited Members

Detailed Description

A RED packet queue disc.

Introspection did not find any typical Config paths.


Attributes

  • Mode: Determines unit for QueueLimit
    • Set with class: ns3::EnumValue
    • Underlying type:
    • Initial value: QUEUE_MODE_PACKETS
    • Flags: construct write
  • MeanPktSize: Average of packet size
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 0:4294967295
    • Initial value: 500
    • Flags: construct write read
  • IdlePktSize: Average packet size used during idle times. Used when m_cautions = 3
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 0:4294967295
    • Initial value: 0
    • Flags: construct write read
  • Wait: True for waiting between dropped packets
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: construct write read
  • Gentle: True to increases dropping probability slowly when average queue exceeds maxthresh
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: construct write read
  • ARED: True to enable ARED
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: construct write read
  • AdaptMaxP: True to adapt m_curMaxP
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: construct write read
  • MinTh: Minimum average length threshold in packets/bytes
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 5
    • Flags: construct write read
  • MaxTh: Maximum average length threshold in packets/bytes
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 15
    • Flags: construct write read
  • QueueLimit: Queue limit in bytes/packets
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 0:4294967295
    • Initial value: 25
    • Flags: construct write
  • QW: Queue weight related to the exponential weighted moving average (EWMA)
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 0.002
    • Flags: construct write read
  • LInterm: The maximum probability of dropping a packet
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 50
    • Flags: construct write read
  • TargetDelay: Target average queuing delay in ARED
    • Set with class: ns3::TimeValue
    • Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
    • Initial value: +5000000.0ns
    • Flags: construct write read
  • Interval: Time interval to update m_curMaxP
    • Set with class: ns3::TimeValue
    • Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
    • Initial value: +500000000.0ns
    • Flags: construct write read
  • Top: Upper bound for m_curMaxP in ARED
    • Set with class: ns3::DoubleValue
    • Underlying type: double 0:1
    • Initial value: 0.5
    • Flags: construct write read
  • Bottom: Lower bound for m_curMaxP in ARED
    • Set with class: ns3::DoubleValue
    • Underlying type: double 0:1
    • Initial value: 0
    • Flags: construct write read
  • Alpha: Increment parameter for m_curMaxP in ARED
    • Set with class: ns3::DoubleValue
    • Underlying type: double 0:1
    • Initial value: 0.01
    • Flags: construct write
  • Beta: Decrement parameter for m_curMaxP in ARED
    • Set with class: ns3::DoubleValue
    • Underlying type: double 0:1
    • Initial value: 0.9
    • Flags: construct write
  • LastSet: Store the last time m_curMaxP was updated
    • Set with class: ns3::TimeValue
    • Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
    • Initial value: +0.0ns
    • Flags: construct write read
  • Rtt: Round Trip Time to be considered while automatically setting m_bottom
    • Set with class: ns3::TimeValue
    • Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
    • Initial value: +100000000.0ns
    • Flags: construct write read
  • Ns1Compat: NS-1 compatibility
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: construct write read
  • LinkBandwidth: The RED link bandwidth
    • Set with class: DataRateValue
    • Underlying type: DataRate
    • Initial value: 1500000bps
    • Flags: construct write read
  • LinkDelay: The RED link delay
    • Set with class: ns3::TimeValue
    • Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
    • Initial value: +20000000.0ns
    • Flags: construct write read

Attributes defined in parent class ns3::QueueDisc

No TraceSources are defined for this type.

TraceSources defined in parent class ns3::QueueDisc

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

Definition at line 81 of file red-queue-disc.h.

Constructor & Destructor Documentation

ns3::RedQueueDisc::RedQueueDisc ( )

RedQueueDisc Constructor.

Create a RED queue disc

Definition at line 201 of file red-queue-disc.cc.

References m_uv, and NS_LOG_FUNCTION.

ns3::RedQueueDisc::~RedQueueDisc ( )
virtual

Destructor.

Destructor

Definition at line 208 of file red-queue-disc.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

int64_t ns3::RedQueueDisc::AssignStreams ( int64_t  stream)

Assign a fixed random variable stream number to the random variables used by this model.

Return the number of streams (possibly zero) that have been assigned.

Parameters
streamfirst stream index to use
Returns
the number of stream indices assigned by this model

Definition at line 297 of file red-queue-disc.cc.

References m_uv, NS_LOG_FUNCTION, and ns3::RandomVariableStream::SetStream().

+ Here is the call graph for this function:

double ns3::RedQueueDisc::CalculatePNew ( double  qAvg,
double  maxTh,
bool  gentle,
double  vA,
double  vB,
double  vC,
double  vD,
double  maxP 
)
private

Returns a probability using these function parameters for the DropEarly function.

Parameters
qAvgAverage queue length
maxThMax avg length threshold
gentle"gentle" algorithm
vAvA
vBvB
vCvC
vDvD
maxPmax_p
Returns
Prob. of packet drop before "count"

Definition at line 657 of file red-queue-disc.cc.

References NS_LOG_FUNCTION.

Referenced by DropEarly().

+ Here is the caller graph for this function:

bool ns3::RedQueueDisc::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 813 of file red-queue-disc.cc.

References ns3::QueueDisc::AddInternalQueue(), ns3::QueueDisc::GetInternalQueue(), GetMode(), ns3::QueueDisc::GetNInternalQueues(), ns3::QueueDisc::GetNPacketFilters(), ns3::QueueDisc::GetNQueueDiscClasses(), m_mode, m_queueLimit, 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:

Ptr< QueueDiscItem > ns3::RedQueueDisc::DoDequeue ( void  )
privatevirtual

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 768 of file red-queue-disc.cc.

References ns3::QueueDisc::GetInternalQueue(), ns3::QueueDisc::GetNBytes(), ns3::QueueDisc::GetNPackets(), m_idle, m_idleTime, ns3::Simulator::Now(), NS_LOG_FUNCTION, and NS_LOG_LOGIC.

+ Here is the call graph for this function:

void ns3::RedQueueDisc::DoDispose ( void  )
protectedvirtual

Dispose of the object.

Reimplemented from ns3::QueueDisc.

Definition at line 214 of file red-queue-disc.cc.

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

+ Here is the call graph for this function:

Ptr< const QueueDiscItem > ns3::RedQueueDisc::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 795 of file red-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::RedQueueDisc::DropEarly ( Ptr< QueueDiscItem item,
uint32_t  qSize 
)
private

Check if a packet needs to be dropped due to probability mark.

Parameters
itemqueue item
qSizequeue size
Returns
0 for no drop/mark, 1 for drop
Todo:
Implement set bit to mark

Definition at line 596 of file red-queue-disc.cc.

References CalculatePNew(), ns3::UniformRandomVariable::GetValue(), m_cautious, m_count, m_countBytes, m_curMaxP, m_isGentle, m_isWait, m_maxTh, m_meanPktSize, m_ptc, m_qAvg, m_qW, m_uv, m_vA, m_vB, m_vC, m_vD, m_vProb, m_vProb1, ModifyP(), NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by DoEnqueue().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

double ns3::RedQueueDisc::Estimator ( uint32_t  nQueued,
uint32_t  m,
double  qAvg,
double  qW 
)
private

Compute the average queue size.

Parameters
nQueuednumber of queued packets
msimulated number of packets arrival during idle period
qAvgaverage queue size
qWqueue weight given to cur q size sample
Returns
new average queue size

Definition at line 578 of file red-queue-disc.cc.

References m_interval, m_isAdaptMaxP, m_lastSet, ns3::Simulator::Now(), NS_LOG_FUNCTION, and UpdateMaxP().

Referenced by DoEnqueue().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

double ns3::RedQueueDisc::GetAredAlpha ( void  )

Get the alpha value to adapt m_curMaxP.

Returns
The alpha value to adapt m_curMaxP.

Definition at line 248 of file red-queue-disc.cc.

References m_alpha, and NS_LOG_FUNCTION.

double ns3::RedQueueDisc::GetAredBeta ( void  )

Get the beta value to adapt m_curMaxP.

Returns
The beta value to adapt m_curMaxP.

Definition at line 267 of file red-queue-disc.cc.

References m_beta, and NS_LOG_FUNCTION.

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

Get the encapsulation mode of this queue.

Get the encapsulation mode of this queue

Returns
The encapsulation mode of this queue.

Definition at line 229 of file red-queue-disc.cc.

References m_mode, and NS_LOG_FUNCTION.

Referenced by CheckConfig(), DoEnqueue(), GetQueueSize(), InitializeParams(), ModifyP(), AdaptiveRedQueueDiscTestCase::RunAdaptiveRedDiscTest(), AutoRedQueueDiscTestCase::RunAutoRedDiscTest(), and RedQueueDiscTestCase::RunRedTest().

+ Here is the caller graph for this function:

uint32_t ns3::RedQueueDisc::GetQueueSize ( void  )

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

Returns
The queue size in bytes or packets.

Definition at line 750 of file red-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 RedQueueDiscTestCase::RunRedTest().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

RedQueueDisc::Stats ns3::RedQueueDisc::GetStats ( )

Get the RED statistics after running.

Returns
The drop statistics.

Definition at line 290 of file red-queue-disc.cc.

References m_stats, and NS_LOG_FUNCTION.

void ns3::RedQueueDisc::InitializeParams ( void  )
privatevirtual

Initialize the queue parameters.

Note: if the link bandwidth changes in the course of the simulation, the bandwidth-dependent RED parameters do not change. This should be fixed, but it would require some extra parameters, and didn't seem worth the trouble...

Implements ns3::QueueDisc.

Definition at line 431 of file red-queue-disc.cc.

References ns3::RedQueueDisc::Stats::forcedDrop, ns3::DataRate::GetBitRate(), GetMode(), ns3::Time::GetSeconds(), m_bottom, m_cautious, m_count, m_countBytes, m_curMaxP, m_idle, m_idleTime, m_isAdaptMaxP, m_isARED, m_isGentle, m_isWait, m_linkBandwidth, m_linkDelay, m_lInterm, m_maxTh, m_meanPktSize, m_minTh, m_old, m_ptc, m_qAvg, m_qW, m_rtt, m_stats, m_targetDelay, m_vA, m_vB, m_vC, m_vD, ns3::NanoSeconds(), NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_INFO, ns3::RedQueueDisc::Stats::qLimDrop, ns3::Queue::QUEUE_MODE_BYTES, and ns3::RedQueueDisc::Stats::unforcedDrop.

+ Here is the call graph for this function:

double ns3::RedQueueDisc::ModifyP ( double  p,
uint32_t  count,
uint32_t  countBytes,
uint32_t  meanPktSize,
bool  wait,
uint32_t  size 
)
private

Returns a probability using these function parameters for the DropEarly function.

Parameters
pProb. of packet drop before "count"
countnumber of packets since last random number generation
countBytesnumber of bytes since last drop
meanPktSizeAvg pkt size
waitTrue for waiting between dropped packets
sizepacket size
Returns
Prob. of packet drop

Definition at line 698 of file red-queue-disc.cc.

References GetMode(), NS_LOG_FUNCTION, and ns3::Queue::QUEUE_MODE_BYTES.

Referenced by DropEarly().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::RedQueueDisc::SetAredAlpha ( double  alpha)

Set the alpha value to adapt m_curMaxP.

Parameters
alphaThe value of alpha to adapt m_curMaxP.

Definition at line 236 of file red-queue-disc.cc.

References m_alpha, NS_LOG_FUNCTION, and NS_LOG_WARN.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

void ns3::RedQueueDisc::SetAredBeta ( double  beta)

Set the beta value to adapt m_curMaxP.

Parameters
betaThe value of beta to adapt m_curMaxP.

Definition at line 255 of file red-queue-disc.cc.

References m_beta, NS_LOG_FUNCTION, and NS_LOG_WARN.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

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

Set the operating mode of this queue.

Set operating mode

Parameters
modeThe operating mode of this queue.

Definition at line 222 of file red-queue-disc.cc.

References m_mode, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

void ns3::RedQueueDisc::SetQueueLimit ( uint32_t  lim)

Set the limit of the queue.

Parameters
limThe limit in bytes or packets.

Definition at line 274 of file red-queue-disc.cc.

References m_queueLimit, and NS_LOG_FUNCTION.

Referenced by GetTypeId(), and RedQueueDiscTestCase::RunRedTest().

+ Here is the caller graph for this function:

void ns3::RedQueueDisc::SetTh ( double  minTh,
double  maxTh 
)

Set the thresh limits of RED.

Parameters
minThMinimum thresh in bytes or packets.
maxThMaximum thresh in bytes or packets.

Definition at line 281 of file red-queue-disc.cc.

References m_maxTh, m_minTh, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by RedQueueDiscTestCase::RunRedTest().

+ Here is the caller graph for this function:

void ns3::RedQueueDisc::UpdateMaxP ( double  newAve,
Time  now 
)
private

Update m_curMaxP.

Parameters
newAvenew average queue length
nowCurrent Time

Definition at line 553 of file red-queue-disc.cc.

References m_alpha, m_beta, m_bottom, m_curMaxP, m_lastSet, m_maxTh, m_minTh, and m_top.

Referenced by Estimator().

+ Here is the caller graph for this function:

Member Data Documentation

double ns3::RedQueueDisc::m_alpha
private

Increment parameter for m_curMaxP in ARED.

Definition at line 295 of file red-queue-disc.h.

Referenced by GetAredAlpha(), SetAredAlpha(), and UpdateMaxP().

double ns3::RedQueueDisc::m_beta
private

Decrement parameter for m_curMaxP in ARED.

Definition at line 296 of file red-queue-disc.h.

Referenced by GetAredBeta(), SetAredBeta(), and UpdateMaxP().

double ns3::RedQueueDisc::m_bottom
private

Lower bound for m_curMaxP in ARED.

Definition at line 294 of file red-queue-disc.h.

Referenced by GetTypeId(), InitializeParams(), and UpdateMaxP().

uint32_t ns3::RedQueueDisc::m_cautious
private

0 for default RED 1 experimental (see red-queue.cc) 2 experimental (see red-queue.cc) 3 use Idle packet size in the ptc

Definition at line 323 of file red-queue-disc.h.

Referenced by DoEnqueue(), DropEarly(), and InitializeParams().

uint32_t ns3::RedQueueDisc::m_count
private

Number of packets since last random number generation.

Definition at line 316 of file red-queue-disc.h.

Referenced by DoEnqueue(), DropEarly(), and InitializeParams().

uint32_t ns3::RedQueueDisc::m_countBytes
private

Number of bytes since last drop.

Definition at line 311 of file red-queue-disc.h.

Referenced by DoEnqueue(), DropEarly(), and InitializeParams().

double ns3::RedQueueDisc::m_curMaxP
private

Current max_p.

Definition at line 308 of file red-queue-disc.h.

Referenced by DropEarly(), InitializeParams(), and UpdateMaxP().

uint32_t ns3::RedQueueDisc::m_idle
private

0/1 idle status

Definition at line 313 of file red-queue-disc.h.

Referenced by DoDequeue(), DoEnqueue(), and InitializeParams().

uint32_t ns3::RedQueueDisc::m_idlePktSize
private

Avg pkt size used during idle times.

Definition at line 281 of file red-queue-disc.h.

Referenced by DoEnqueue(), and GetTypeId().

Time ns3::RedQueueDisc::m_idleTime
private

Start of current idle period.

Definition at line 324 of file red-queue-disc.h.

Referenced by DoDequeue(), DoEnqueue(), and InitializeParams().

Time ns3::RedQueueDisc::m_interval
private

Time interval to update m_curMaxP.

Definition at line 292 of file red-queue-disc.h.

Referenced by Estimator(), and GetTypeId().

bool ns3::RedQueueDisc::m_isAdaptMaxP
private

True to adapt m_curMaxP.

Definition at line 285 of file red-queue-disc.h.

Referenced by Estimator(), GetTypeId(), and InitializeParams().

bool ns3::RedQueueDisc::m_isARED
private

True to enable Adaptive RED.

Definition at line 284 of file red-queue-disc.h.

Referenced by GetTypeId(), and InitializeParams().

bool ns3::RedQueueDisc::m_isGentle
private

True to increases dropping prob.

slowly when ave queue exceeds maxthresh

Definition at line 283 of file red-queue-disc.h.

Referenced by DoEnqueue(), DropEarly(), GetTypeId(), and InitializeParams().

bool ns3::RedQueueDisc::m_isNs1Compat
private

Ns-1 compatibility.

Definition at line 298 of file red-queue-disc.h.

Referenced by DoEnqueue(), and GetTypeId().

bool ns3::RedQueueDisc::m_isWait
private

True for waiting between dropped packets.

Definition at line 282 of file red-queue-disc.h.

Referenced by DropEarly(), GetTypeId(), and InitializeParams().

Time ns3::RedQueueDisc::m_lastSet
private

Last time m_curMaxP was updated.

Definition at line 309 of file red-queue-disc.h.

Referenced by Estimator(), GetTypeId(), and UpdateMaxP().

DataRate ns3::RedQueueDisc::m_linkBandwidth
private

Link bandwidth.

Definition at line 299 of file red-queue-disc.h.

Referenced by GetTypeId(), and InitializeParams().

Time ns3::RedQueueDisc::m_linkDelay
private

Link delay.

Definition at line 300 of file red-queue-disc.h.

Referenced by GetTypeId(), and InitializeParams().

double ns3::RedQueueDisc::m_lInterm
private

The max probability of dropping a packet.

Definition at line 290 of file red-queue-disc.h.

Referenced by GetTypeId(), and InitializeParams().

double ns3::RedQueueDisc::m_maxTh
private

Max avg length threshold (bytes), should be >= 2*minTh.

Definition at line 287 of file red-queue-disc.h.

Referenced by DoEnqueue(), DropEarly(), GetTypeId(), InitializeParams(), SetTh(), and UpdateMaxP().

uint32_t ns3::RedQueueDisc::m_meanPktSize
private

Avg pkt size.

Definition at line 280 of file red-queue-disc.h.

Referenced by DoEnqueue(), DropEarly(), GetTypeId(), and InitializeParams().

double ns3::RedQueueDisc::m_minTh
private

Min avg length threshold (bytes)

Definition at line 286 of file red-queue-disc.h.

Referenced by DoEnqueue(), GetTypeId(), InitializeParams(), SetTh(), and UpdateMaxP().

Queue::QueueMode ns3::RedQueueDisc::m_mode
private

Mode (Bytes or packets)

Definition at line 279 of file red-queue-disc.h.

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

uint32_t ns3::RedQueueDisc::m_old
private

0 when average queue first exceeds threshold

Definition at line 312 of file red-queue-disc.h.

Referenced by DoEnqueue(), and InitializeParams().

double ns3::RedQueueDisc::m_ptc
private

packet time constant in packets/second

Definition at line 314 of file red-queue-disc.h.

Referenced by DoEnqueue(), DropEarly(), and InitializeParams().

double ns3::RedQueueDisc::m_qAvg
private

Average queue length.

Definition at line 315 of file red-queue-disc.h.

Referenced by DoEnqueue(), DropEarly(), and InitializeParams().

uint32_t ns3::RedQueueDisc::m_queueLimit
private

Queue limit in bytes / packets.

Definition at line 288 of file red-queue-disc.h.

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

double ns3::RedQueueDisc::m_qW
private

Queue weight given to cur queue size sample.

Definition at line 289 of file red-queue-disc.h.

Referenced by DoEnqueue(), DropEarly(), GetTypeId(), and InitializeParams().

Time ns3::RedQueueDisc::m_rtt
private

Rtt to be considered while automatically setting m_bottom in ARED.

Definition at line 297 of file red-queue-disc.h.

Referenced by GetTypeId(), and InitializeParams().

Stats ns3::RedQueueDisc::m_stats
private

RED statistics.

Definition at line 276 of file red-queue-disc.h.

Referenced by DoEnqueue(), GetStats(), and InitializeParams().

Time ns3::RedQueueDisc::m_targetDelay
private

Target average queuing delay in ARED.

Definition at line 291 of file red-queue-disc.h.

Referenced by GetTypeId(), and InitializeParams().

double ns3::RedQueueDisc::m_top
private

Upper bound for m_curMaxP in ARED.

Definition at line 293 of file red-queue-disc.h.

Referenced by GetTypeId(), and UpdateMaxP().

Ptr<UniformRandomVariable> ns3::RedQueueDisc::m_uv
private

rng stream

Definition at line 326 of file red-queue-disc.h.

Referenced by AssignStreams(), DoDispose(), DropEarly(), and RedQueueDisc().

double ns3::RedQueueDisc::m_vA
private

1.0 / (m_maxTh - m_minTh)

Definition at line 304 of file red-queue-disc.h.

Referenced by DropEarly(), and InitializeParams().

double ns3::RedQueueDisc::m_vB
private

-m_minTh / (m_maxTh - m_minTh)

Definition at line 305 of file red-queue-disc.h.

Referenced by DropEarly(), and InitializeParams().

double ns3::RedQueueDisc::m_vC
private

(1.0 - m_curMaxP) / m_maxTh - used in "gentle" mode

Definition at line 306 of file red-queue-disc.h.

Referenced by DropEarly(), and InitializeParams().

double ns3::RedQueueDisc::m_vD
private

2.0 * m_curMaxP - 1.0 - used in "gentle" mode

Definition at line 307 of file red-queue-disc.h.

Referenced by DropEarly(), and InitializeParams().

double ns3::RedQueueDisc::m_vProb
private

Prob.

of packet drop

Definition at line 310 of file red-queue-disc.h.

Referenced by DoEnqueue(), and DropEarly().

double ns3::RedQueueDisc::m_vProb1
private

Prob.

of packet drop before "count"

Definition at line 303 of file red-queue-disc.h.

Referenced by DropEarly().


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