satellite-queue.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013 Magister Solutions Ltd.
 *
 * 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: Jani Puttonen <jani.puttonen@magister.fi>
 */
 
#ifndef SATELLITE_QUEUE_H_
#define SATELLITE_QUEUE_H_
 
#include <ns3/nstime.h>
#include <ns3/object.h>
#include <ns3/packet.h>
#include <ns3/traced-callback.h>
 
#include <queue>
 
namespace ns3
{
 
class SatQueue : public Object
{
  public:
    static TypeId GetTypeId(void);
 
    struct QueueStats_t
    {
        QueueStats_t()
            : m_incomingRateKbps(0.0),
              m_outgoingRateKbps(0.0),
              m_volumeInBytes(0),
              m_volumeOutBytes(0),
              m_queueSizeBytes(0)
        {
        }
 
        double m_incomingRateKbps;
        double m_outgoingRateKbps;
        uint32_t m_volumeInBytes;
        uint32_t m_volumeOutBytes;
        uint32_t m_queueSizeBytes;
    };
 
    typedef enum
    {
        FIRST_BUFFERED_PKT,
        BUFFERED_PKT
    } QueueEvent_t;
 
    SatQueue();
 
    SatQueue(uint8_t flowId);
 
    ~SatQueue();
 
    virtual void DoDispose();
 
    typedef Callback<void, Ptr<Packet>> LogonCallback;
 
    typedef Callback<void, SatQueue::QueueEvent_t, uint8_t> QueueEventCallback;
 
    virtual bool IsEmpty(void) const;
 
    virtual bool Enqueue(Ptr<Packet> p);
 
    virtual Ptr<Packet> Dequeue(void);
 
    virtual void PushFront(Ptr<Packet> p);
 
    virtual Ptr<const Packet> Peek(void) const;
 
    void DequeueAll(void);
 
    void SetFlowId(uint32_t flowId);
 
    void AddQueueEventCallback(SatQueue::QueueEventCallback cb);
 
    void AddLogonCallback(SatQueue::LogonCallback cb);
 
    uint32_t GetNPackets(void) const;
 
    uint32_t GetNBytes(void) const;
 
    uint32_t GetTotalReceivedBytes(void) const;
 
    uint32_t GetTotalReceivedPackets(void) const;
    uint32_t GetTotalDroppedBytes(void) const;
 
    uint32_t GetTotalDroppedPackets(void) const;
 
    void ResetStatistics(void);
 
    QueueStats_t GetQueueStatistics(bool reset);
 
    uint32_t GetNumSmallerPackets(uint32_t maxPacketSizeBytes) const;
 
  protected:
    void Drop(Ptr<Packet> packet);
 
  private:
    void SendEvent(SatQueue::QueueEvent_t event);
 
    void ResetShortTermStatistics();
 
    typedef std::vector<QueueEventCallback> EventCallbackContainer_t;
    typedef std::deque<Ptr<Packet>> PacketContainer_t;
 
    EventCallbackContainer_t m_queueEventCallbacks;
 
    PacketContainer_t m_packets;
 
    uint32_t m_maxPackets;
 
    uint8_t m_flowId;
 
    // Statistics
    uint32_t m_nBytes;
    uint32_t m_nTotalReceivedBytes;
    uint32_t m_nPackets;
    uint32_t m_nTotalReceivedPackets;
    uint32_t m_nTotalDroppedBytes;
    uint32_t m_nTotalDroppedPackets;
 
    // Short term statistics
    uint32_t m_nEnqueBytesSinceReset;
    uint32_t m_nDequeBytesSinceReset;
    Time m_statResetTime;
 
    // Trace callbacks
    TracedCallback<Ptr<const Packet>> m_traceEnqueue;
    TracedCallback<Ptr<const Packet>> m_traceDequeue;
    TracedCallback<Ptr<const Packet>> m_traceDrop;
 
    LogonCallback m_logonCallback;
};
 
} // namespace ns3
 
#endif /* SATELLITE_QUEUE_H_ */