satellite-fwd-link-scheduler-time-slicing.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: Bastien Tauran <bastien.tauran@viveris.fr>
 */
 
#ifndef SAT_FWD_LINK_SCHEDULER_TIME_SLICING_H
#define SAT_FWD_LINK_SCHEDULER_TIME_SLICING_H
 
#include "satellite-fwd-link-scheduler.h"
 
#include "ns3/pointer.h"
 
#include <map>
#include <stdint.h>
#include <utility>
#include <vector>
 
namespace ns3
{

 
class SatFwdLinkSchedulerTimeSlicing : public SatFwdLinkScheduler
{
  public:
    static TypeId GetTypeId(void);

    SatFwdLinkSchedulerTimeSlicing();

    SatFwdLinkSchedulerTimeSlicing(Ptr<SatBbFrameConf> conf,
                                   Mac48Address address,
                                   double carrierBandwidthInHz);

    virtual void NotifyConstructionCompleted() override;

    ~SatFwdLinkSchedulerTimeSlicing();

    virtual std::pair<Ptr<SatBbFrame>, const Time> GetNextFrame();

    virtual void ClearAllPackets();
 
  private:
    void DoDispose(void);

    void ScheduleBbFrames();

    void SendAndClearSymbolsSentStat();

    void GetSchedulingObjects(std::vector<Ptr<SatSchedulingObject>>& output);
 
    /*
     * Give the total sending time of all the BBFrames in all the slices.
     * @return The total duration.
     */
    Time GetTotalDuration();
 
    /*
     * Send a control packet to the UT to inform which slices to subscribe
     * @param address The MAC address of the UT
     * @param slices The slices id the destination must subscribe to.
     */
    void SendTimeSliceSubscription(Mac48Address address, std::vector<uint8_t> slices);
 
    /*
     * Compute if a new BBFrame can be openned while respecting symbol rate constraints.
     * @param address The MAC destination address of the BBFrame
     * @param priorityClass The priority class of the new BBFrame
     * @param modcod The modcod of the new BBFrame
     * @return true if a new BBFrame can be openned
     */
    bool CanOpenBbFrame(Mac48Address address, uint32_t priorityClass, SatEnums::SatModcod_t modcod);
 
    /*
     * Compute the number of symbols to send for a slice, including a new BBFrame to be open
     * @param sliceId The slice tested.
     * @param modcod The modcod of the new BBFrame. If is SAT_NONVALID_MODCOD, the new BBFrame is
     * ignored. \return The total number of symbols for all the BBFrames.
     */
    uint32_t GetSymbols(uint8_t sliceId, SatEnums::SatModcod_t modcod);

    std::map<uint8_t, Ptr<SatBbFrameContainer>> m_bbFrameContainers;

    std::map<Mac48Address, uint8_t> m_slicesMapping;

    std::map<uint8_t, uint32_t> m_symbolsSent;

    uint8_t m_numberOfSlices;

    uint8_t m_lastSliceAssigned;

    uint8_t m_lastSliceDequeued;
};
 
} // namespace ns3
 
#endif /* SAT_FWD_LINK_SCHEDULER_TIME_SLICING_H */