satellite-traffic-helper.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013 Magister Solutions Ltd
 * Copyright (c) 2020 CNES
 *
 * 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 __SATELLITE_TRAFFIC_HELPER_H__
#define __SATELLITE_TRAFFIC_HELPER_H__
 
#include <ns3/application-container.h>
#include <ns3/cbr-application.h>
#include <ns3/config.h>
#include <ns3/object.h>
#include <ns3/satellite-helper.h>
#include <ns3/satellite-stats-helper-container.h>
#include <ns3/string.h>
 
namespace ns3
{
class SatTrafficHelper : public Object
{
  public:
    typedef enum
    {
        CBR,     // implemented
        HTTP,    // implemented
        NRTV,    // implemented
        CUSTOM,  // implemented
        POISSON, // TODO -> implemented, but verify formula and repartition of offTime
        VISIO,   // TODO
        VOIP     // implemented
    } TrafficType_t;
 
    typedef enum
    {
        G_711_1,
        G_711_2,
        G_723_1,
        G_729_2,
        G_729_3
    } VoipCodec_t;
 
    typedef enum
    {
        RTN_LINK,
        FWD_LINK
    } TrafficDirection_t; // TODO merge with enum from SimulationHelper
 
    static TypeId GetTypeId(void);
 
    TypeId GetInstanceTypeId(void) const;
 
    SatTrafficHelper();
 
    SatTrafficHelper(Ptr<SatHelper> satHelper,
                     Ptr<SatStatsHelperContainer> satStatsHelperContainer);
 
    virtual ~SatTrafficHelper()
    {
    }
 
    void AddCbrTraffic(TrafficDirection_t direction,
                       std::string interval,
                       uint32_t packetSize,
                       NodeContainer gws,
                       NodeContainer uts,
                       Time startTime,
                       Time stopTime,
                       Time startDelay);
 
    void AddHttpTraffic(TrafficDirection_t direction,
                        NodeContainer gws,
                        NodeContainer uts,
                        Time startTime,
                        Time stopTime,
                        Time startDelay);
 
    void AddNrtvTraffic(TrafficDirection_t direction,
                        NodeContainer gws,
                        NodeContainer uts,
                        Time startTime,
                        Time stopTime,
                        Time startDelay);
 
    void AddPoissonTraffic(TrafficDirection_t direction,
                           Time onTime,
                           Time offTimeExpMean,
                           std::string rate,
                           uint32_t packetSize,
                           NodeContainer gws,
                           NodeContainer uts,
                           Time startTime,
                           Time stopTime,
                           Time startDelay);
 
    void AddVoipTraffic(TrafficDirection_t direction,
                        VoipCodec_t codec,
                        NodeContainer gws,
                        NodeContainer uts,
                        Time startTime,
                        Time stopTime,
                        Time startDelay);
 
    void AddCustomTraffic(TrafficDirection_t direction,
                          std::string interval,
                          uint32_t packetSize,
                          NodeContainer gws,
                          NodeContainer uts,
                          Time startTime,
                          Time stopTime,
                          Time startDelay);
 
    void ChangeCustomTraffic(Time delay, std::string interval, uint32_t packetSize);
 
    // TODO same with add/remove nodes ?
 
    // TODO check if correct if several GWs -> stats per GW
 
  private:
    typedef struct
    {
        ApplicationContainer application;
        Time start;
        Time stop;
        bool created;
    } CustomTrafficInfo_s;
 
    Ptr<SatHelper> m_satHelper; // Pointer to the SatHelper objet
    Ptr<SatStatsHelperContainer>
        m_satStatsHelperContainer; // Pointer to the SatStatsHelperContainer objet
 
    CustomTrafficInfo_s m_last_custom_application; // Last application container of custom traffic
 
    void UpdateAttribute(Ptr<CbrApplication> application,
                         std::string interval,
                         uint32_t packetSize);
 
    bool HasSinkInstalled(Ptr<Node> node, uint16_t port);
};
 
} // namespace ns3
 
#endif /* __SATELLITE_TRAFFIC_HELPER_H__ */
 
// More generic
// call functons AddVoipTraffic, AddPoissonTraffic, etc.
// each one call a generic function (with for loops). Has a additionnal function -> subfunction, for
// traffic with parameters Subfunction (private) call GW*UT times