|
A Discrete-Event Network Simulator
|
API |
|
|
A Discrete-Event Network Simulator
|
API |
Template class for packet Queues. More...
#include "csma-net-device.h"
Inheritance diagram for ns3::Queue< Item >: Collaboration diagram for ns3::Queue< Item >:Public Member Functions | |
| Queue () | |
| virtual | ~Queue () |
| virtual Ptr< Item > | Dequeue (void)=0 |
| Remove an item from the Queue (each subclass defines the position), counting it as dequeued. More... | |
| virtual bool | Enqueue (Ptr< Item > item)=0 |
| Place an item into the Queue (each subclass defines the position) More... | |
| void | Flush (void) |
| Flush the queue. More... | |
| virtual Ptr< const Item > | Peek (void) const =0 |
| Get a copy of an item in the queue (each subclass defines the position) without removing it. More... | |
| virtual Ptr< Item > | Remove (void)=0 |
| Remove an item from the Queue (each subclass defines the position), counting it as dropped. More... | |
| Public Member Functions inherited from ns3::QueueBase | |
| QueueBase () | |
| virtual | ~QueueBase () |
| QueueSize | GetCurrentSize (void) const |
| uint32_t | GetMaxBytes (void) const |
| uint32_t | GetMaxPackets (void) const |
| QueueSize | GetMaxSize (void) const |
| QueueBase::QueueMode | GetMode (void) const |
| Get the operating mode of this device. More... | |
| uint32_t | GetNBytes (void) const |
| uint32_t | GetNPackets (void) const |
| uint32_t | GetTotalDroppedBytes (void) const |
| uint32_t | GetTotalDroppedBytesAfterDequeue (void) const |
| uint32_t | GetTotalDroppedBytesBeforeEnqueue (void) const |
| uint32_t | GetTotalDroppedPackets (void) const |
| uint32_t | GetTotalDroppedPacketsAfterDequeue (void) const |
| uint32_t | GetTotalDroppedPacketsBeforeEnqueue (void) const |
| uint32_t | GetTotalReceivedBytes (void) const |
| uint32_t | GetTotalReceivedPackets (void) const |
| bool | IsEmpty (void) const |
| void | ResetStatistics (void) |
| Resets the counts for dropped packets, dropped bytes, received packets, and received bytes. More... | |
| void | SetMaxBytes (uint32_t maxBytes) |
| Set the maximum amount of bytes that can be stored in this queue. More... | |
| void | SetMaxPackets (uint32_t maxPackets) |
| Set the maximum amount of packets that can be stored in this queue. More... | |
| void | SetMaxSize (QueueSize size) |
| Set the maximum size of this queue. More... | |
| void | SetMode (QueueBase::QueueMode mode) |
| Set the operating mode of this device. More... | |
| Public Member Functions inherited from ns3::Object | |
| Object () | |
| Constructor. More... | |
| virtual | ~Object () |
| Destructor. More... | |
| void | AggregateObject (Ptr< Object > other) |
| Aggregate two Objects together. More... | |
| void | Dispose (void) |
| Dispose of this Object. More... | |
| AggregateIterator | GetAggregateIterator (void) const |
| Get an iterator to the Objects aggregated to this one. More... | |
| virtual TypeId | GetInstanceTypeId (void) const |
| Get the most derived TypeId for this Object. More... | |
| template<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 () | |
| Default 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 operator. More... | |
| void | Ref (void) const |
| Increment the reference count. More... | |
| void | Unref (void) const |
| Decrement the reference count. More... | |
| Public Member Functions inherited from ns3::ObjectBase | |
| virtual | ~ObjectBase () |
| Virtual destructor. More... | |
| void | GetAttribute (std::string name, AttributeValue &value) const |
| Get the value of an attribute, raising fatal errors if unsuccessful. More... | |
| bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
| Get the value of an attribute without raising erros. More... | |
| void | SetAttribute (std::string name, const AttributeValue &value) |
| Set a single attribute, raising fatal errors if unsuccessful. More... | |
| bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
| Set a single attribute without raising errors. More... | |
| bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
| Connect a TraceSource to a Callback with a context. More... | |
| bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
| Connect a TraceSource to a Callback without a context. More... | |
| bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
| Disconnect from a TraceSource a Callback previously connected with a context. More... | |
| bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
| Disconnect from a TraceSource a Callback previously connected without a context. More... | |
Static Public Member Functions | |
| static TypeId | GetTypeId (void) |
| Get the type ID. More... | |
| Static Public Member Functions inherited from ns3::QueueBase | |
| static void | AppendItemTypeIfNotPresent (std::string &typeId, const std::string &itemType) |
| Append the item type to the provided type ID if the latter does not end with '>'. More... | |
| static TypeId | GetTypeId (void) |
| Get the type ID. More... | |
| Static Public Member Functions inherited from ns3::Object | |
| static TypeId | GetTypeId (void) |
| Register this type. More... | |
| Static Public Member Functions inherited from ns3::ObjectBase | |
| static TypeId | GetTypeId (void) |
| Get the type ID. More... | |
Protected Types | |
| typedef std::list< Ptr< Item > >::const_iterator | ConstIterator |
| Const iterator. More... | |
Protected Member Functions | |
| Ptr< Item > | DoDequeue (ConstIterator pos) |
| Pull the item to dequeue from the queue. More... | |
| bool | DoEnqueue (ConstIterator pos, Ptr< Item > item) |
| Push an item in the queue. More... | |
| Ptr< const Item > | DoPeek (ConstIterator pos) const |
| Peek the front item in the queue. More... | |
| Ptr< Item > | DoRemove (ConstIterator pos) |
| Pull the item to drop from the queue. More... | |
| void | DropAfterDequeue (Ptr< Item > item) |
| Drop a packet after dequeue. More... | |
| void | DropBeforeEnqueue (Ptr< Item > item) |
| Drop a packet before enqueue. More... | |
| ConstIterator | Head (void) const |
| Get a const iterator which refers to the first item in the queue. More... | |
| ConstIterator | Tail (void) const |
| Get a const iterator which indicates past-the-last item in the queue. More... | |
| Protected Member Functions inherited from ns3::Object | |
| Object (const Object &o) | |
| Copy an Object. More... | |
| virtual void | DoDispose (void) |
| Destructor implementation. More... | |
| virtual void | DoInitialize (void) |
| Initialize() implementation. More... | |
| virtual void | NotifyNewAggregate (void) |
| Notify all Objects aggregated to this one of a new Object being aggregated. More... | |
| Protected Member Functions inherited from ns3::ObjectBase | |
| void | ConstructSelf (const AttributeConstructionList &attributes) |
| Complete construction of ObjectBase; invoked by derived classes. More... | |
| virtual void | NotifyConstructionCompleted (void) |
| Notifier called once the ObjectBase is fully constructed. More... | |
Private Attributes | |
| std::list< Ptr< Item > > | m_packets |
| the items in the queue More... | |
| TracedCallback< Ptr< const Item > > | m_traceDequeue |
| Traced callback: fired when a packet is dequeued. More... | |
| TracedCallback< Ptr< const Item > > | m_traceDrop |
| Traced callback: fired when a packet is dropped. More... | |
| TracedCallback< Ptr< const Item > > | m_traceDropAfterDequeue |
| Traced callback: fired when a packet is dropped after dequeue. More... | |
| TracedCallback< Ptr< const Item > > | m_traceDropBeforeEnqueue |
| Traced callback: fired when a packet is dropped before enqueue. More... | |
| TracedCallback< Ptr< const Item > > | m_traceEnqueue |
| Traced callback: fired when a packet is enqueued. More... | |
| NS_LOG_TEMPLATE_DECLARE | |
| the log component More... | |
Additional Inherited Members | |
| Public Types inherited from ns3::QueueBase | |
| enum | QueueMode { QUEUE_MODE_PACKETS, QUEUE_MODE_BYTES } |
| Enumeration of the modes supported in the class. 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... | |
Template class for packet Queues.
This class defines the subset of the base APIs for packet queues in the ns-3 system that is dependent on the type of enqueued objects.
Queue is a template class. The type of the objects stored within the queue is specified by the type parameter, which can be any class providing a GetSize () method (e.g., Packet, QueueDiscItem, etc.). Subclasses need to implement the DoEnqueue, DoDequeue, DoRemove and DoPeek methods.
Users of the Queue template class usually hold a queue through a smart pointer, hence forward declaration is recommended to avoid pulling the implementation of the templates included in this file. Thus, do not include queue.h but add the following forward declaration in your .h file:
Then, include queue.h in the corresponding .cc file.
Definition at line 39 of file csma-net-device.h.
|
protected |
| ns3::Queue< Item >::Queue | ( | ) |
|
virtual |
|
pure virtual |
Remove an item from the Queue (each subclass defines the position), counting it as dequeued.
Implemented in ns3::DropTailQueue< Item >.
|
protected |
Pull the item to dequeue from the queue.
| pos | the position of the item to dequeue |
Definition at line 532 of file queue.h.
References NS_ASSERT, NS_LOG_FUNCTION, and NS_LOG_LOGIC().
Here is the call graph for this function:
|
protected |
Push an item in the queue.
| pos | the position where the item is inserted |
| item | the item to enqueue |
Definition at line 504 of file queue.h.
References NS_LOG_FUNCTION, and NS_LOG_LOGIC().
Here is the call graph for this function:
|
protected |
Peek the front item in the queue.
| pos | the position of the item to peek |
Definition at line 604 of file queue.h.
References NS_LOG_FUNCTION, and NS_LOG_LOGIC().
Here is the call graph for this function:
|
protected |
Pull the item to drop from the queue.
| pos | the position of the item to remove |
Definition at line 561 of file queue.h.
References NS_ASSERT, NS_LOG_FUNCTION, and NS_LOG_LOGIC().
Here is the call graph for this function:
|
protected |
Drop a packet after dequeue.
| item | item that was dropped |
This method is called by the base class when a Remove operation is requested and by the subclasses to notify parent (this class) that a packet has been dropped for other reasons after being dequeued.
Definition at line 647 of file queue.h.
References NS_LOG_FUNCTION, and NS_LOG_LOGIC().
Here is the call graph for this function:
|
protected |
Drop a packet before enqueue.
| item | item that was dropped |
This method is called by the base class when a packet is dropped because the queue is full and by the subclasses to notify parent (this class) that a packet has been dropped for other reasons before being enqueued.
Definition at line 631 of file queue.h.
References NS_LOG_FUNCTION, and NS_LOG_LOGIC().
Here is the call graph for this function:
|
pure virtual |
Place an item into the Queue (each subclass defines the position)
| item | item to enqueue |
Implemented in ns3::DropTailQueue< Item >.
| void ns3::Queue< Item >::Flush | ( | void | ) |
|
static |
Get the type ID.
Implementation of the templates declared above.
Definition at line 466 of file queue.h.
References ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().
Here is the call graph for this function:
|
protected |
Get a const iterator which refers to the first item in the queue.
Subclasses can browse the items in the queue by using an iterator
|
pure virtual |
Get a copy of an item in the queue (each subclass defines the position) without removing it.
Implemented in ns3::DropTailQueue< Item >.
|
pure virtual |
Remove an item from the Queue (each subclass defines the position), counting it as dropped.
Implemented in ns3::DropTailQueue< Item >.
|
protected |
Get a const iterator which indicates past-the-last item in the queue.
Subclasses can browse the items in the queue by using an iterator
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
1.8.9.1 
