wifi-mac-queue-item.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2005, 2009 INRIA
 * Copyright (c) 2009 MIRKO BANCHI
 *
 * 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
 *
 * Authors: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 *          Mirko Banchi <mk.banchi@gmail.com>
 *          Stefano Avallone <stavallo@unina.it>
 */

#ifndef WIFI_MAC_QUEUE_ITEM_H
#define WIFI_MAC_QUEUE_ITEM_H

#include "ns3/nstime.h"
#include "wifi-mac-header.h"
#include "amsdu-subframe-header.h"
#include <list>

namespace ns3 {

class QosBlockedDestinations;
class Packet;
class WifiMacQueue;

class WifiMacQueueItem : public SimpleRefCount<WifiMacQueueItem>
{
public:
  WifiMacQueueItem (Ptr<const Packet> p, const WifiMacHeader & header);

  WifiMacQueueItem (Ptr<const Packet> p, const WifiMacHeader & header, Time tstamp);

  virtual ~WifiMacQueueItem ();

  Ptr<const Packet> GetPacket (void) const;

  const WifiMacHeader & GetHeader (void) const;

  WifiMacHeader & GetHeader (void);

  Mac48Address GetDestinationAddress (void) const;

  Time GetTimeStamp (void) const;

  uint32_t GetSize (void) const;

  uint32_t GetPacketSize (void) const;

  bool IsFragment (void) const;

  void Aggregate (Ptr<const WifiMacQueueItem> msdu);

  typedef std::list<std::pair<Ptr<const Packet>, AmsduSubframeHeader> > DeaggregatedMsdus;
  typedef std::list<std::pair<Ptr<const Packet>, AmsduSubframeHeader> >::const_iterator DeaggregatedMsdusCI;

  DeaggregatedMsdusCI begin (void);
  DeaggregatedMsdusCI end (void);

  typedef std::list<Ptr<WifiMacQueueItem>>::const_iterator ConstIterator;
  struct QueueIteratorPair
  {
    WifiMacQueue* queue;  
    ConstIterator it;     
  };

  bool IsQueued (void) const;

  const std::list<QueueIteratorPair>& GetQueueIteratorPairs (void) const;

  Ptr<Packet> GetProtocolDataUnit (void) const;

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

private:
  void DoAggregate (Ptr<const WifiMacQueueItem> msdu);

  friend class WifiMacQueue;  // to set QueueIteratorPair information

  Ptr<const Packet> m_packet;                   
  WifiMacHeader m_header;                       
  Time m_tstamp;                                
  DeaggregatedMsdus m_msduList;                 
  std::list<QueueIteratorPair> m_queueIts;      
};

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

} //namespace ns3

#endif /* WIFI_MAC_QUEUE_ITEM_H */