satellite-ut-scheduler.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_UT_SCHEDULER_H_
#define SATELLITE_UT_SCHEDULER_H_
 
#include "satellite-frame-conf.h"
 
#include "ns3/callback.h"
#include "ns3/mac48-address.h"
#include "ns3/object.h"
 
#include <stdint.h>
#include <vector>
 
namespace ns3
{
 
class Packet;
class SatNodeInfo;
class SatLowerLayerServiceConf;
class SatSchedulingObject;

class SortByMetric
{
  public:
    SortByMetric(const std::vector<uint32_t>& m)
        : m_cont(m)
    {
    }

    bool operator()(uint8_t p1, uint8_t p2)
    {
        return m_cont.at(p1) < m_cont.at(p2);
    }
 
  private:
    const std::vector<uint32_t>& m_cont;
};

class SatUtScheduler : public Object
{
  public:
    SatUtScheduler();

    SatUtScheduler(Ptr<SatLowerLayerServiceConf> lls);

    virtual void NotifyConstructionCompleted() override;

    virtual ~SatUtScheduler();

    typedef enum
    {
        STRICT = 0,
        LOOSE = 1
    } SatCompliancePolicy_t;

    static TypeId GetTypeId(void);

    virtual void DoDispose(void);

    typedef Callback<void, std::vector<Ptr<SatSchedulingObject>>&> SchedContextCallback;

    typedef Callback<Ptr<Packet>, uint32_t, Mac48Address, uint8_t, uint32_t&, uint32_t&>
        TxOpportunityCallback;

    typedef std::vector<uint32_t> ByteCounterContainer_t;

    void SetSchedContextCallback(SatUtScheduler::SchedContextCallback cb);

    void SetTxOpportunityCallback(SatUtScheduler::TxOpportunityCallback cb);

    void DoScheduling(std::vector<Ptr<Packet>>& packets,
                      uint32_t payloadBytes,
                      SatTimeSlotConf::SatTimeSlotType_t type,
                      uint8_t rcIndex,
                      SatCompliancePolicy_t policy);

    virtual void SetNodeInfo(Ptr<SatNodeInfo> nodeInfo);
 
  private:
    uint32_t DoSchedulingForRcIndex(std::vector<Ptr<Packet>>& packets,
                                    uint32_t& payloadBytes,
                                    uint8_t rcIndex);

    std::vector<uint8_t> GetPrioritizedRcIndexOrder();

    SatUtScheduler::SchedContextCallback m_schedContextCallback;

    SatUtScheduler::TxOpportunityCallback m_txOpportunityCallback;

    Ptr<SatLowerLayerServiceConf> m_llsConf;

    bool m_prioritizeControl;

    uint32_t m_framePduHeaderSizeInBytes;

    Ptr<SatNodeInfo> m_nodeInfo;

    ByteCounterContainer_t m_utScheduledByteCounters;

    std::vector<uint8_t> m_rcIndices;
};
 
} // namespace ns3
 
#endif /* SATELLITE_UT_SCHEDULER_H_ */