153 lines
3.6 KiB
C++
153 lines
3.6 KiB
C++
/* -*- 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
|
|
*/
|
|
|
|
#ifndef DROPTAIL_H
|
|
#define DROPTAIL_H
|
|
|
|
#include "ns3/queue.h"
|
|
|
|
namespace ns3 {
|
|
|
|
/**
|
|
* \ingroup queue
|
|
*
|
|
* \brief A FIFO packet queue that drops tail-end packets on overflow
|
|
*/
|
|
template <typename Item>
|
|
class DropTailQueue : public Queue<Item>
|
|
{
|
|
public:
|
|
/**
|
|
* \brief Get the type ID.
|
|
* \return the object TypeId
|
|
*/
|
|
static TypeId GetTypeId (void);
|
|
/**
|
|
* \brief DropTailQueue Constructor
|
|
*
|
|
* Creates a droptail queue with a maximum size of 100 packets by default
|
|
*/
|
|
DropTailQueue ();
|
|
|
|
virtual ~DropTailQueue ();
|
|
|
|
virtual bool Enqueue (Ptr<Item> item);
|
|
virtual Ptr<Item> Dequeue (void);
|
|
virtual Ptr<Item> Remove (void);
|
|
virtual Ptr<const Item> Peek (void) const;
|
|
|
|
private:
|
|
using Queue<Item>::begin;
|
|
using Queue<Item>::end;
|
|
using Queue<Item>::DoEnqueue;
|
|
using Queue<Item>::DoDequeue;
|
|
using Queue<Item>::DoRemove;
|
|
using Queue<Item>::DoPeek;
|
|
|
|
NS_LOG_TEMPLATE_DECLARE; //!< redefinition of the log component
|
|
};
|
|
|
|
|
|
/**
|
|
* Implementation of the templates declared above.
|
|
*/
|
|
|
|
template <typename Item>
|
|
TypeId
|
|
DropTailQueue<Item>::GetTypeId (void)
|
|
{
|
|
static TypeId tid = TypeId (("ns3::DropTailQueue<" + GetTypeParamName<DropTailQueue<Item> > () + ">").c_str ())
|
|
.SetParent<Queue<Item> > ()
|
|
.SetGroupName ("Network")
|
|
.template AddConstructor<DropTailQueue<Item> > ()
|
|
;
|
|
return tid;
|
|
}
|
|
|
|
template <typename Item>
|
|
DropTailQueue<Item>::DropTailQueue () :
|
|
Queue<Item> (),
|
|
NS_LOG_TEMPLATE_DEFINE ("DropTailQueue")
|
|
{
|
|
NS_LOG_FUNCTION (this);
|
|
}
|
|
|
|
template <typename Item>
|
|
DropTailQueue<Item>::~DropTailQueue ()
|
|
{
|
|
NS_LOG_FUNCTION (this);
|
|
}
|
|
|
|
template <typename Item>
|
|
bool
|
|
DropTailQueue<Item>::Enqueue (Ptr<Item> item)
|
|
{
|
|
NS_LOG_FUNCTION (this << item);
|
|
|
|
return DoEnqueue (end (), item);
|
|
}
|
|
|
|
template <typename Item>
|
|
Ptr<Item>
|
|
DropTailQueue<Item>::Dequeue (void)
|
|
{
|
|
NS_LOG_FUNCTION (this);
|
|
|
|
Ptr<Item> item = DoDequeue (begin ());
|
|
|
|
NS_LOG_LOGIC ("Popped " << item);
|
|
|
|
return item;
|
|
}
|
|
|
|
template <typename Item>
|
|
Ptr<Item>
|
|
DropTailQueue<Item>::Remove (void)
|
|
{
|
|
NS_LOG_FUNCTION (this);
|
|
|
|
Ptr<Item> item = DoRemove (begin ());
|
|
|
|
NS_LOG_LOGIC ("Removed " << item);
|
|
|
|
return item;
|
|
}
|
|
|
|
template <typename Item>
|
|
Ptr<const Item>
|
|
DropTailQueue<Item>::Peek (void) const
|
|
{
|
|
NS_LOG_FUNCTION (this);
|
|
|
|
return DoPeek (begin ());
|
|
}
|
|
|
|
// The following explicit template instantiation declarations prevent all the
|
|
// translation units including this header file to implicitly instantiate the
|
|
// DropTailQueue<Packet> class and the DropTailQueue<QueueDiscItem> class. The
|
|
// unique instances of these classes are explicitly created through the macros
|
|
// NS_OBJECT_TEMPLATE_CLASS_DEFINE (DropTailQueue,Packet) and
|
|
// NS_OBJECT_TEMPLATE_CLASS_DEFINE (DropTailQueue,QueueDiscItem), which are included
|
|
// in drop-tail-queue.cc
|
|
extern template class DropTailQueue<Packet>;
|
|
extern template class DropTailQueue<QueueDiscItem>;
|
|
|
|
} // namespace ns3
|
|
|
|
#endif /* DROPTAIL_H */
|