wimax-mac-queue.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2007,2008 INRIA
 *
 * 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: Jahanzeb Farooq <jahanzeb.farooq@sophia.inria.fr>
 */

#ifndef WIMAX_MAC_QUEUE_H
#define WIMAX_MAC_QUEUE_H

#include <queue>
#include <stdint.h>
#include "wimax-mac-header.h"
#include "ns3/packet.h"
#include "ns3/object.h"
#include "ns3/traced-callback.h"
#include "ns3/nstime.h"

namespace ns3 {

class WimaxMacQueue : public Object
{
public:
  static TypeId GetTypeId (void);
  WimaxMacQueue (void);
  WimaxMacQueue (uint32_t maxSize);
  ~WimaxMacQueue (void);
  void SetMaxSize (uint32_t maxSize);
  uint32_t GetMaxSize (void) const;
  bool Enqueue (Ptr<Packet> packet, const MacHeaderType &hdrType,
                const GenericMacHeader &hdr);
  Ptr<Packet> Dequeue (MacHeaderType::HeaderType packetType);
  Ptr<Packet> Dequeue (MacHeaderType::HeaderType packetType,
                       uint32_t availableByte);

  Ptr<Packet> Peek (GenericMacHeader &hdr) const;
  Ptr<Packet> Peek (GenericMacHeader &hdr, Time &timeStamp) const;

  Ptr<Packet> Peek (MacHeaderType::HeaderType packetType) const;
  Ptr<Packet> Peek (MacHeaderType::HeaderType packetType, Time &timeStamp) const;

  bool IsEmpty (void) const;

  bool IsEmpty (MacHeaderType::HeaderType packetType) const;

  uint32_t GetSize (void) const;
  uint32_t GetNBytes (void) const;

  bool CheckForFragmentation (MacHeaderType::HeaderType packetType);
  uint32_t GetFirstPacketHdrSize (MacHeaderType::HeaderType packetType);
  uint32_t GetFirstPacketPayloadSize (MacHeaderType::HeaderType packetType);
  uint32_t GetFirstPacketRequiredByte (MacHeaderType::HeaderType packetType);
  uint32_t GetQueueLengthWithMACOverhead (void);

  void SetFragmentation (MacHeaderType::HeaderType packetType);
  void SetFragmentNumber (MacHeaderType::HeaderType packetType);
  void SetFragmentOffset (MacHeaderType::HeaderType packetType, uint32_t offset);

  struct QueueElement
  {
    QueueElement (void);
    QueueElement (Ptr<Packet> packet,
                  const MacHeaderType &hdrType,
                  const GenericMacHeader &hdr,
                  Time timeStamp);
    uint32_t GetSize (void) const;
    Ptr<Packet> m_packet; 
    MacHeaderType m_hdrType; 
    GenericMacHeader m_hdr; 
    Time m_timeStamp; 

    bool m_fragmentation; 
    uint32_t m_fragmentNumber; 
    uint32_t m_fragmentOffset; 

    void SetFragmentation (void);
    void SetFragmentNumber (void);
    void SetFragmentOffset (uint32_t offset);
  };

private:

  WimaxMacQueue::QueueElement Front (MacHeaderType::HeaderType packetType) const;
  void Pop (MacHeaderType::HeaderType packetType);

  typedef std::deque<QueueElement> PacketQueue;
  PacketQueue m_queue; 
  uint32_t m_maxSize; 
  uint32_t m_bytes; 
  uint32_t m_nrDataPackets; 
  uint32_t m_nrRequestPackets; 

  TracedCallback<Ptr<const Packet> > m_traceEnqueue; 
  TracedCallback<Ptr<const Packet> > m_traceDequeue; 
  TracedCallback<Ptr<const Packet> > m_traceDrop; 
public:
  const WimaxMacQueue::PacketQueue & GetPacketQueue (void) const;
};

} // namespace ns3

#endif /* WIMAX_MAC_QUEUE_H */