TransportSettings.h

Go to the documentation of this file.

#ifndef _MADARA_TRANSPORT_SETTINGS_H_
#define _MADARA_TRANSPORT_SETTINGS_H_
 
#include <string>
#include <sstream>
#include <vector>
#include <map>
#include <ostream>
 
#include "madara/LockType.h"
#include "madara/knowledge/KnowledgeRecord.h"
#include "madara/knowledge/ThreadSafeContext.h"
#include "madara/expression/ExpressionTree.h"
#include "madara/expression/Interpreter.h"
#include "madara/MadaraExport.h"
#include "madara/transport/Fragmentation.h"
 
namespace madara
{
namespace transport
{
// forward declare for friending
class Base;
 
enum Types
{
  NO_TRANSPORT = 0,
  SPLICE = 1,
  NDDS = 2,
  TCP = 3,
  UDP = 4,
  MULTICAST = 5,
  BROADCAST = 6,
  REGISTRY_SERVER = 7,
  REGISTRY_CLIENT = 8,
  ZMQ = 9
};
 
enum Reliabilities
{
  BEST_EFFORT = 0,
  RELIABLE = 1
};
 
enum Messages
{
  ASSIGN = 0,
  OPERATION = 1,
  MULTIASSIGN = 2,
  REGISTER = 3,
  LATENCY = 10,
  LATENCY_AGGREGATE = 11,
  LATENCY_SUMMATION = 12,
  VOTE = 20
};
 
MADARA_EXPORT std::string types_to_string(int id);
 
class MADARA_EXPORT TransportSettings
{
public:
  // allow transport::Base to alter private/protected members
  friend class Base;
 
#define DEFAULT_DOMAIN "KaRL"
 
  typedef std::vector<std::string> Voters;
 
  static const uint32_t DEFAULT_QUEUE_LENGTH = 500000;
 
  static const uint32_t DEFAULT_DEADLINE = 0;
 
  static const uint32_t DEFAULT_TRANSPORT = NO_TRANSPORT;
 
  static const uint32_t DEFAULT_RELIABILITY = RELIABLE;
 
#define DEFAULT_ID 0
 
#define DEFAULT_PROCESSES 1
 
#define MAXIMUM_RESEND_ATTEMPTS 10
 
  TransportSettings() = default;
 
  TransportSettings(const TransportSettings& settings);
 
  virtual ~TransportSettings();
 
  void operator=(const TransportSettings& settings);
 
  void add_read_domain(const std::string & domain);
 
  void add_host(const std::string & host);
 
  void clear_hosts(void);
 
  void clear_read_domains(void);
 
  void get_read_domains(std::vector<std::string>& domains) const;
 
  bool is_reading_domain(const std::string domain) const;
 
  size_t num_read_domains(void) const;
 
  void debug_to_kb(const std::string& prefix = ".transport");
 
  virtual void load(
      const std::string& filename, const std::string& prefix = "transport");
 
  virtual void load_text(
      const std::string& filename, const std::string& prefix = "transport");
 
  virtual void save(const std::string& filename,
      const std::string& prefix = "transport") const;
 
  virtual void save_text(const std::string& filename,
      const std::string& prefix = "transport") const;
 
 
  std::string write_domain = DEFAULT_DOMAIN;
 
  uint32_t read_threads = 1;
 
  uint32_t queue_length = DEFAULT_QUEUE_LENGTH;
 
  uint32_t type = DEFAULT_TRANSPORT;
 
  uint32_t max_fragment_size = 62000;
 
  int resend_attempts = MAXIMUM_RESEND_ATTEMPTS;
 
  uint32_t fragment_queue_length = 100;
 
  uint32_t reliability = DEFAULT_RELIABILITY;
 
  uint32_t id = DEFAULT_ID;
 
  uint32_t processes = DEFAULT_PROCESSES;
 
  std::string on_data_received_logic;
 
  bool delay_launch = false;
 
  bool never_exit = false;
 
  bool send_reduced_message_header = false;
 
  mutable OriginatorFragmentMap fragment_map;
 
  double slack_time = 0;
 
  double read_thread_hertz = 1000.0;
 
  double max_send_hertz = 0.0;
 
  std::vector<std::string> hosts;
 
  bool no_sending = false;
 
  bool no_receiving = false;
 
  bool send_history = false;
 
  std::string debug_to_kb_prefix = "";
 
private:
  std::map<std::string, int> read_domains_;
};
 
inline std::string type_name(const TransportSettings& settings)
{
  std::string name = "none";
 
  switch (settings.type)
  {
    case 0:
      name = "None";
      break;
    case 1:
      name = "PrismTech DDS";
      break;
    case 2:
      name = "RTI DDS";
      break;
    case 3:
      name = "TCP (unsupported)";
      break;
    case 4:
      name = "UDP Unicast";
      break;
    case 5:
      name = "UDP Multicast";
      break;
    case 6:
      name = "UDP Broadcast";
      break;
    case 7:
      name = "UDP P2P Registry Server";
      break;
    case 8:
      name = "UDP P2P Registry Client";
      break;
    case 9:
      name = "ZeroMQ Pub/Sub";
      break;
  }
 
  return name;
}
}
}
 
#include "TransportSettings.inl"
 
#endif  // _MADARA_TRANSPORT_SETTINGS_H_