A Discrete-Event Network Simulator
API
queue-limits.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2016 Universita' degli Studi di Napoli Federico II
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Authors: Pasquale Imputato <p.imputato@gmail.com>
19  * Stefano Avallone <stefano.avallone@unina.it>
20  */
21 
22 #ifndef QUEUE_LIMITS_H
23 #define QUEUE_LIMITS_H
24 
25 #include "ns3/object.h"
26 
27 namespace ns3 {
28 
43 class QueueLimits : public Object {
44 public:
49  static TypeId GetTypeId (void);
50 
51  virtual ~QueueLimits ();
52 
56  virtual void Reset () = 0;
57 
62  virtual void Completed (uint32_t count) = 0;
63 
72  virtual int32_t Available () const = 0;
73 
78  virtual void Queued (uint32_t count) = 0;
79 };
80 
81 } // namespace ns3
82 
83 #endif /* QUEUE_LIMITS_H */
ns3::Object
A base class which provides memory management and object aggregation.
Definition: object.h:88
ns3::QueueLimits
Abstract base class for NetDevice queue length controller.
Definition: queue-limits.h:43
ns3::QueueLimits::~QueueLimits
virtual ~QueueLimits()
Definition: queue-limits.cc:41
ns3::QueueLimits::Reset
virtual void Reset()=0
Reset queue limits state.
ns3::QueueLimits::Queued
virtual void Queued(uint32_t count)=0
Record the number of bytes queued.
ns3::QueueLimits::GetTypeId
static TypeId GetTypeId(void)
Get the type ID.
Definition: queue-limits.cc:32
ns3::QueueLimits::Completed
virtual void Completed(uint32_t count)=0
Record number of completed bytes and recalculate the limit.
ns3::QueueLimits::Available
virtual int32_t Available() const =0
Available is called from NotifyTransmittedBytes to calculate the number of bytes that can be passed a...
ns3::TypeId
a unique identifier for an interface.
Definition: type-id.h:59
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.