satellite-dama-entry.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2014 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: Sami Rantanen <sami.rantanen@magister.fi>
 */
 
#ifndef SATELLITE_DAMA_ENTRY_H
#define SATELLITE_DAMA_ENTRY_H
 
#include "satellite-lower-layer-service.h"
 
#include "ns3/simple-ref-count.h"
 
#include <map>
#include <stdint.h>
#include <vector>
 
namespace ns3
{

class SatDamaEntry : public SimpleRefCount<SatDamaEntry>
{
  public:
    SatDamaEntry();

    SatDamaEntry(Ptr<SatLowerLayerServiceConf> llsConf);

    ~SatDamaEntry();

    uint8_t GetRcCount() const;

    uint32_t GetCraBasedBytes(Time duration) const;

    uint32_t GetMinRateBasedBytes(Time duration) const;

    uint32_t GetRbdcBasedBytes(Time duration) const;

    uint32_t GetVbdcBasedBytes() const;

    uint16_t GetCraInKbps(uint8_t index) const;

    uint16_t GetMinRbdcInKbps(uint8_t index) const;

    uint16_t GetRbdcInKbps(uint8_t index) const;

    void UpdateRbdcInKbps(uint8_t index, uint16_t rateInKbps);

    uint32_t GetVbdcInBytes(uint8_t index) const;

    void UpdateVbdcInBytes(uint8_t index, uint32_t volumeInBytes);

    void SetVbdcInBytes(uint8_t index, uint32_t volumeInBytes);

    void ResetDynamicRatePersistence();

    void DecrementDynamicRatePersistence();

    void ResetVolumeBacklogPersistence();

    void DecrementVolumeBacklogPersistence();
 
  private:
    uint8_t m_dynamicRatePersistence;
    uint8_t m_volumeBacklogPersistence;
    Ptr<SatLowerLayerServiceConf> m_llsConf;
    std::vector<uint16_t> m_dynamicRateRequestedInKbps;
    std::vector<uint32_t> m_volumeBacklogRequestedInBytes;
};
 
} // namespace ns3
 
#endif /* SATELLITE_DAMA_ENTRY_H */