queue-item.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2016 Universita' degli Studi di Napoli Federico II
 *
 * 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
 *
 * Author: Stefano Avallone <stefano.avallone@unina.it>
 */
#ifndef QUEUE_ITEM_H
#define QUEUE_ITEM_H

#include "ns3/ptr.h"
#include "ns3/simple-ref-count.h"
#include <ns3/address.h>
#include "ns3/nstime.h"

namespace ns3 {

class Packet;

class QueueItem : public SimpleRefCount<QueueItem>
{
public:
  QueueItem (Ptr<Packet> p);

  virtual ~QueueItem ();

  Ptr<Packet> GetPacket (void) const;

  virtual uint32_t GetSize (void) const;

  enum Uint8Values
    {
      IP_DSFIELD
    };

  virtual bool GetUint8Value (Uint8Values field, uint8_t &value) const;

  virtual void Print (std::ostream &os) const;

  typedef void (* TracedCallback) (Ptr<const QueueItem> item);

private:
  QueueItem ();
  QueueItem (const QueueItem &);
  QueueItem &operator = (const QueueItem &);

  Ptr<Packet> m_packet;
};

std::ostream& operator<< (std::ostream& os, const QueueItem &item);


class QueueDiscItem : public QueueItem {
public:
  QueueDiscItem (Ptr<Packet> p, const Address & addr, uint16_t protocol);

  virtual ~QueueDiscItem ();

  Address GetAddress (void) const;

  uint16_t GetProtocol (void) const;

  uint8_t GetTxQueueIndex (void) const;

  void SetTxQueueIndex (uint8_t txq);

  Time GetTimeStamp (void) const;

  void SetTimeStamp (Time t);

  virtual void AddHeader (void) = 0;

  virtual void Print (std::ostream &os) const;

  virtual bool Mark (void) = 0;

  virtual uint32_t Hash (uint32_t perturbation = 0) const;

private:
  QueueDiscItem ();
  QueueDiscItem (const QueueDiscItem &);
  QueueDiscItem &operator = (const QueueDiscItem &);

  Address m_address;      
  uint16_t m_protocol;    
  uint8_t m_txq;          
  Time m_tstamp;          
};

} // namespace ns3

#endif /* QUEUE_ITEM_H */