/usr/include/ns3/queue.h is in libns3-dev 3.13+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2007 University of Washington
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
// The queue base class does not have any limit based on the number
// of packets or number of bytes. It is, conceptually, infinite
// by default. Only subclasses define limitations.
// The base class implements tracing and basic statistics calculations.
#ifndef QUEUE_H
#define QUEUE_H
#include <string>
#include <list>
#include "ns3/packet.h"
#include "ns3/object.h"
#include "ns3/traced-callback.h"
namespace ns3 {
/**
* \ingroup network
* \defgroup queue Queue
*/
/**
* \ingroup queue
* \brief Abstract base class for packet Queues
*
* This class defines the base APIs for packet queues in the ns-3 system
*/
class Queue : public Object
{
public:
static TypeId GetTypeId (void);
Queue ();
virtual ~Queue ();
/**
* \return true if the queue is empty; false otherwise
*/
bool IsEmpty (void) const;
/**
* Place a packet into the rear of the Queue
* \param p packet to enqueue
* \return True if the operation was successful; false otherwise
*/
bool Enqueue (Ptr<Packet> p);
/**
* Remove a packet from the front of the Queue
* \return 0 if the operation was not successful; the packet otherwise.
*/
Ptr<Packet> Dequeue (void);
/**
* Get a copy of the item at the front of the queue without removing it
* \return 0 if the operation was not successful; the packet otherwise.
*/
Ptr<const Packet> Peek (void) const;
/**
* Flush the queue.
*/
void DequeueAll (void);
/**
* \return The number of packets currently stored in the Queue
*/
uint32_t GetNPackets (void) const;
/**
* \return The number of bytes currently occupied by the packets in the Queue
*/
uint32_t GetNBytes (void) const;
/**
* \return The total number of bytes received by this Queue since the
* simulation began, or since ResetStatistics was called, according to
* whichever happened more recently
*
*/
uint32_t GetTotalReceivedBytes (void) const;
/**
* \return The total number of packets received by this Queue since the
* simulation began, or since ResetStatistics was called, according to
* whichever happened more recently
*/
uint32_t GetTotalReceivedPackets (void) const;
/**
* \return The total number of bytes dropped by this Queue since the
* simulation began, or since ResetStatistics was called, according to
* whichever happened more recently
*/
uint32_t GetTotalDroppedBytes (void) const;
/**
* \return The total number of bytes dropped by this Queue since the
* simulation began, or since ResetStatistics was called, according to
* whichever happened more recently
*/
uint32_t GetTotalDroppedPackets (void) const;
/**
* Resets the counts for dropped packets, dropped bytes, received packets, and
* received bytes.
*/
void ResetStatistics (void);
#if 0
// average calculation requires keeping around
// a buffer with the date of arrival of past received packets
// which are within the average window
// so, it is quite costly to do it all the time.
// Hence, it is disabled by default and must be explicitely
// enabled with this method which specifies the size
// of the average window in time units.
void EnableRunningAverage (Time averageWindow);
void DisableRunningAverage (void);
// average
double GetQueueSizeAverage (void);
double GetReceivedBytesPerSecondAverage (void);
double GetReceivedPacketsPerSecondAverage (void);
double GetDroppedBytesPerSecondAverage (void);
double GetDroppedPacketsPerSecondAverage (void);
// variance
double GetQueueSizeVariance (void);
double GetReceivedBytesPerSecondVariance (void);
double GetReceivedPacketsPerSecondVariance (void);
double GetDroppedBytesPerSecondVariance (void);
double GetDroppedPacketsPerSecondVariance (void);
#endif
private:
virtual bool DoEnqueue (Ptr<Packet> p) = 0;
virtual Ptr<Packet> DoDequeue (void) = 0;
virtual Ptr<const Packet> DoPeek (void) const = 0;
protected:
// called by subclasses to notify parent of packet drops.
void Drop (Ptr<Packet> packet);
private:
TracedCallback<Ptr<const Packet> > m_traceEnqueue;
TracedCallback<Ptr<const Packet> > m_traceDequeue;
TracedCallback<Ptr<const Packet> > m_traceDrop;
uint32_t m_nBytes;
uint32_t m_nTotalReceivedBytes;
uint32_t m_nPackets;
uint32_t m_nTotalReceivedPackets;
uint32_t m_nTotalDroppedBytes;
uint32_t m_nTotalDroppedPackets;
};
} // namespace ns3
#endif /* QUEUE_H */
|