ndn-scenario-helper.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
#ifndef NDNSIM_HELPER_NDN_SCENARIO_HELPER_HPP
#define NDNSIM_HELPER_NDN_SCENARIO_HELPER_HPP

#include "ndn-stack-helper.hpp"

#include "ns3/net-device.h"
#include "ns3/node.h"

#include <ndn-cxx/name.hpp>
#include <map>

namespace ns3 {
namespace ndn {

class ScenarioHelper
{
public:
  struct RouteInfo
  {
    std::string node1;
    std::string node2;
    Name prefix;
    int32_t metric;
  };

  /*
   * @brief Application information for addApps method
   *
   * It is preferred to use initializer list to indirectly pass AppInfo's to addApps
   * method.
   */
  struct AppInfo
  {
    std::string node;
    std::string name;
    std::initializer_list<std::pair<std::string, std::string>> params;
    std::string start;
    std::string end;
  };

public:
  ScenarioHelper();

  void
  createTopology(std::initializer_list<std::initializer_list<std::string>/*node clique*/> topology,
                 bool shouldInstallNdnStack = true);

  void
  addRoutes(std::initializer_list<RouteInfo> routes);

  void
  addApps(std::initializer_list<AppInfo> apps);

public: // topology accessors
  Ptr<Node>
  getNode(const std::string& nodeName);

  shared_ptr<Face>
  getFace(const std::string& node1, const std::string& node2);

  Ptr<NetDevice>
  getNetDevice(const std::string& node1, const std::string& node2);

  void
  disableRibManager();

  // Cannot be disabled for now
  // /**
  //  * \brief Disable Face Manager
  //  */
  // void
  // disableFaceManager();

  void
  disableStrategyChoiceManager();

  void
  disableForwarderStatusManager();

  StackHelper&
  getStackHelper();

private:
  Ptr<Node>
  getOrCreateNode(const std::string& nodeName);

private:
  bool m_isTopologyInitialized;
  StackHelper ndnHelper;
  std::map<std::string, std::map<std::string, Ptr<NetDevice>>> links;
  std::map<std::string, Ptr<Node>> nodes;
};

} // namespace ndn
} // namespace ns3

#endif // NDNSIM_HELPER_NDN_SCENARIO_HELPER_HPP