Apama  10.3.1.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
sag_connectivity_plugins.hpp
Go to the documentation of this file.
1 /*
2  * Title: sag_connectivity_plugins.hpp
3  * Description: C++ API for writing connectivity plugins
4  * $Copyright (c) 2015-2018 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.$
5  * Use, reproduction, transfer, publication or disclosure is prohibited except as specifically provided for in your License Agreement with Software AG
6  * @Version: $Id: sag_connectivity_plugins.hpp 337051 2018-09-06 13:31:46Z matj $
7  */
8 
17 #ifndef _SAG_CONNECTIVITY_PLUGINS_HPP_
18 #define _SAG_CONNECTIVITY_PLUGINS_HPP_
19 
20 #include <sag_connectivity_cpp.hpp>
21 #include <sag_plugin_logging.hpp>
22 #include <memory>
23 #include <mutex>
24 
25 // must define __STDC_FORMAT_MACROS before first include of inttypes else printf macros won't be defined
26 #ifndef __STDC_FORMAT_MACROS
27 #define __STDC_FORMAT_MACROS 1
28 #endif
29 #include <inttypes.h>
30 
31 namespace com {
32 namespace softwareag {
33 namespace connectivity {
34 
35 namespace
36 {
40  void replace(std::string &input, const std::string &from, const std::string &to)
41  {
42  size_t pos = 0;
43  while((pos = input.find(from, pos)) != std::string::npos)
44  {
45  input.replace(pos, from.length(), to);
46  pos =+ to.length();
47  }
48  }
49 
53  std::string to_string(const Message &m, bool truncate=true)
54  {
55  std::string payload = to_string(m.getPayload());
56  if (truncate && payload.length() > 200) payload = payload.substr(0, 196) + " ...";
57  // security sanitization to prevent log message faking
58  replace(payload, "\n", "\\n");
59  replace(payload, "\r", "\\r");
60  return "Message<metadata="+to_string(m.getMetadataMap())+", payload="+payload+">";
61  }
62 }
63 
69 enum class Direction {
73  TOWARDS_HOST = 1,
78 
79 };
80 
85 class PluginHost {
86  friend class Plugin;
87 public:
88  typedef std::unique_ptr<PluginHost> ptr_t;
89 
104  void enableReliability(Direction direction) {
105  if (SAG_ERROR_OK != sag_enable_reliability(chain, static_cast<int>(direction))) {
106  throw std::runtime_error("An error occurred while setting chain reliability");
107  }
108  }
109 
111  bool isShuttingDown() {
112  bool isShuttingDown = false;
113  if (SAG_ERROR_OK != sag_is_host_shutting_down(chain, isShuttingDown)) {
114  throw std::runtime_error("An error occurred while checking if host is shutting down");
115  }
116  return isShuttingDown;
117  }
118 private:
122  PluginHost(void* chain = nullptr) :chain(chain) {}
123  void* chain;
124 };
125 
126 // forward decl for parameters friend
127 class Plugin;
128 
139 {
140  // for constructor access to connectivityManager
141  friend class Plugin;
142 
143 public:
145 
147 
152  const map_t &getConfig() const { return config; }
153 
157  const std::string &getChainId() const { return chainId; }
158 
162  const std::string &getPluginName() const { return pluginName; }
163 
164 protected:
168  PluginConstructorParameters(const std::string &pluginName, const std::string &chainId, const map_t &config, void* connectivityManager, void* chain)
169  : chainId(chainId), pluginName(pluginName), config(config.copy()), connectivityManager(connectivityManager), chain(chain)
170  {}
171 
172 private:
173  std::string chainId;
174  std::string pluginName;
175  map_t config;
177  void* connectivityManager;
179  void* chain;
180 };
181 
184 {
185 public:
189  TransportConstructorParameters(const std::string &pluginName, const std::string &chainId, const map_t &config, void* connectivityManager, void* reserved)
190  : PluginConstructorParameters(pluginName, chainId, config, connectivityManager, reserved)
191  {}
192 };
193 
196 {
197 public:
201  CodecConstructorParameters(const std::string &pluginName, const std::string &chainId, const map_t &config, void* connectivityManager, void* reserved)
202  : PluginConstructorParameters(pluginName, chainId, config, connectivityManager, reserved)
203  {}
207  CodecConstructorParameters(const std::string &pluginName)
208  : PluginConstructorParameters(pluginName, "", map_t{}, nullptr, nullptr)
209  {}
210 };
211 
212 
227 {
228 public:
229 
233  static const char* STATUS_ONLINE() { return "ONLINE"; }
237  static const char* STATUS_STARTING() { return "STARTING"; }
241  static const char* STATUS_FAILED() { return "FAILED"; }
242 
253  {
254  friend class StatusReporter;
255  public:
256 
257  ~StatusItem()
258  {
259  sag_delete_user_status_item(connectivityManager, underlying);
260  underlying.item = nullptr;
261  }
262 
268  void setStatus(const std::string &value)
269  {
270  std::unique_lock<std::mutex> ul(status_lock);
271  setStatusLocked(value);
272  }
273 
282  void setStatus(int64_t value)
283  {
284  std::unique_lock<std::mutex> ul(status_lock);
285  intValue = value;
286  setStatusLocked(convert_to_details::integerToString(value));
287  }
288 
294  std::string getStatus() { return lastValue; }
295 
303  void increment(int64_t incrementValue = 1)
304  {
305  std::unique_lock<std::mutex> ul(status_lock);
306  intValue += incrementValue;
307  setStatusLocked(convert_to_details::integerToString(intValue));
308  }
309 
312  const std::string &key() { return mkey; }
313 
314  private:
315  StatusItem(const StatusItem& other) = delete; // non construction-copyable
316  StatusItem& operator=(const StatusItem&) = delete; // non copyable
317 
318  StatusItem(void* connectivityManager, const std::string &key, const std::string &initialValue, const int64_t intValue)
319  : intValue(intValue),
320  mkey(key),
321  lastValue(initialValue),
322  connectivityManager(connectivityManager),
323  underlying(sag_create_user_status_item(connectivityManager, key.c_str(), initialValue.c_str()))
324  {
325  if (!underlying.item)
326  {
327  std::ostringstream oss;
328  oss << "Failed to create status item '" << key << "' (ensure the key is unique and that this plug-in has not been shutdown already)";
329  throw std::runtime_error(oss.str());
330  }
331  }
332 
333  void setStatusLocked(const std::string &value)
334  {
335  if (value == lastValue) return; // no-op this case
336  lastValue = value;
337 
338  sag_set_user_status_item(underlying, value.c_str());
339  }
340 
341  int64_t intValue;
342  const std::string mkey;
343  std::string lastValue;
344  void* connectivityManager;
345  sag_status_item_t underlying;
346  std::mutex status_lock;
347  };
348 
350  typedef std::unique_ptr<StatusItem> item_ptr;
351 
365  item_ptr createStatusItem(const std::string &key, const std::string &initialValue)
366  {
367  return std::unique_ptr<StatusItem>(new StatusItem(connectivityManager, key, initialValue, 0));
368  }
369 
382  item_ptr createStatusItem(const std::string &key, int64_t initialValue)
383  {
384  std::ostringstream oss;
385  oss << initialValue;
386  return std::unique_ptr<StatusItem>(new StatusItem(connectivityManager, key, oss.str(), initialValue));
387  }
388 
399  void setStatus(const map_t &statusmap)
400  {
401  sag_set_user_status_map(connectivityManager, reinterpret_cast<const sag_underlying_map_t&>(statusmap));
402  // keep track of what keys we've added so we can automatically remove them when we're destroyed
403  for (auto it = statusmap.cbegin(); it != statusmap.cend(); it++)
404  if (it->first.type_tag() == SAG_DATA_STRING) // ignore invalid ones
405  {
406  if (it->second.empty())
407  mapKeysToCleanup.erase(it->first);
408  else
409  mapKeysToCleanup.insert(it->first.copy(), std::move(data_t()));
410  }
411  }
412 
413 
414 
418  ~StatusReporter()
419  {
420  if (!mapKeysToCleanup.empty())
421  sag_set_user_status_map(connectivityManager, reinterpret_cast<const sag_underlying_map_t&>(mapKeysToCleanup));
422  }
423 
427  explicit StatusReporter(void *connectivityManager) : connectivityManager(connectivityManager), mapKeysToCleanup()
428  {
429  }
430 
431 private:
432  void* connectivityManager;
433  map_t mapKeysToCleanup;
434 
435 
436  StatusReporter() = delete;
437 
438  // non-copyable, due to the cleanup code we don't want people to shoot themselves in the foot by having multiple copies
439  StatusReporter(const StatusReporter& other) = delete;
440  StatusReporter& operator=(const StatusReporter&) = delete;
441 
442 };
443 
451 class Plugin
452 {
453 public:
457  Plugin(const std::string &pluginName, const std::string &chainId, const map_t &config)
458  : name(pluginName), pluginName(pluginName), chainId(chainId), config(config.copy()), host(new PluginHost()), LOGGER("connectivity." + pluginName + "." + chainId), logger("connectivity." + name + "." + chainId), statusReporter()
459  {
460  logger.info("The %s connectivity plug-in in chain '%s' is using the deprecated legacy (std::string&,std::string&,map_t&) constructor. We recommend changing to use the recommended (PluginConstructorParameters&) constructor instead.",
461  pluginName.c_str(), chainId.c_str());
462  }
463 
464  /* Constructor.
465  * @since 9.12.0.1
466  */
467  Plugin(const PluginConstructorParameters &params)
468  : name(params.getPluginName()), pluginName(params.getPluginName()), chainId(params.getChainId()), config(params.getConfig().copy()),
469  host(new PluginHost(params.chain)), LOGGER("connectivity." + params.getPluginName() + "." + params.getChainId()), logger("connectivity." + pluginName + "." + chainId),
470  statusReporter(new StatusReporter(params.connectivityManager))
471  {
472  }
473 
479  virtual ~Plugin() {}
480 
491  virtual void start() {}
492 
500  virtual void hostReady() {}
501 
524  virtual void shutdown() {}
526  const std::string &getName() const { return name; }
527 protected:
530  const std::string name;
534  const std::string pluginName;
536  const std::string chainId;
544  const PluginHost::ptr_t host;
553  if (statusReporter) return *statusReporter;
554  throw std::runtime_error("Cannot call getStatusReporter when using the legacy constructor");
555  }
556 
557 public:
564 
569 private:
570  std::unique_ptr<StatusReporter> statusReporter;
571 };
572 
577 class HostSide
578 {
579 public:
581  virtual ~HostSide() {}
583  typedef std::unique_ptr<HostSide> ptr_t;
603  virtual void sendBatchTowardsHost(Message *start, Message *end) = 0;
604 
612  void sendBatchTowardsHost(Message &&message) {
613  sendBatchTowardsHost(&message, &message+1);
614  }
615 
625  template<typename IT>
626  auto sendBatchTowardsHost(const IT &begin, const IT &end) -> typename std::enable_if<
627  !std::is_const<ampl::remove_ref_t<decltype(*begin)>>::value &&
628  ampl::is_same<Message, ampl::remove_const_t<ampl::remove_ref_t<decltype(*begin)>>>::value
629  , void>::type // this ensures we can only pass in non-const iterator pairs to Message
630  {
631  if(begin == end) sendBatchTowardsHost((Message*) nullptr, (Message*) nullptr);
632  else sendBatchTowardsHost(&(*begin), (&(*(end-1)))+1);
633  }
634 };
635 
640 class RemoteHostSide: public HostSide
641 {
642 public:
643  RemoteHostSide(sag_plugin_t other, sag_send_fn_t fn): other(other), fn(fn) {}
644  virtual ~RemoteHostSide() {}
645  virtual void sendBatchTowardsHost(Message *start, Message *end);
646 private:
647  sag_plugin_t other;
648  sag_send_fn_t fn;
649 };
650 
656 {
657 public:
659  virtual ~TransportSide() {}
661  typedef std::unique_ptr<TransportSide> ptr_t;
682  virtual void sendBatchTowardsTransport(Message *start, Message *end) = 0;
683 
692  sendBatchTowardsTransport(&message, &message+1);
693  }
694 
704  template<typename IT>
705  auto sendBatchTowardsTransport(const IT &begin, const IT &end) -> typename std::enable_if<
706  !std::is_const<ampl::remove_ref_t<decltype(*begin)>>::value &&
707  ampl::is_same<Message, ampl::remove_const_t<ampl::remove_ref_t<decltype(*begin)>>>::value
708  , void>::type // this ensures we can only pass in non-const iterator pairs to Message
709  {
710  if(begin == end) sendBatchTowardsTransport((Message*) nullptr, (Message*) nullptr);
711  else sendBatchTowardsTransport(&(*begin), (&(*(end-1)))+1);
712  }
713 };
714 
719 class RemoteTransportSide: public TransportSide
720 {
721 public:
722  RemoteTransportSide(sag_plugin_t other, sag_send_fn_t fn): other(other), fn(fn) {}
723  virtual ~RemoteTransportSide() {}
724  virtual void sendBatchTowardsTransport(Message *start, Message *end);
725 private:
726  sag_plugin_t other;
727  sag_send_fn_t fn;
728 };
729 
730 
755 class AbstractCodec: public Plugin, public HostSide, public TransportSide
756 {
757 public:
759 
775  AbstractCodec(const std::string &pluginName, const std::string &chainId, const map_t &config)
776  : Plugin(pluginName, chainId, config)
777  {}
778 
788  : Plugin(params)
789  {}
790 
791  // These methods do not need to show up in doxygen
792  /* Called between construction and start() to set the hostSide field */
793  virtual void setNextTowardsHost(HostSide::ptr_t &&host)
794  {
795  hostSide = std::move(host);
796  }
797  /* Called between construction and start() to set the transportSide field */
798  virtual void setNextTowardsTransport(TransportSide::ptr_t &&transport)
799  {
800  transportSide = std::move(transport);
801  }
802 protected:
808 
814 };
815 
848 {
849 public:
851 
866  AbstractTransport(const std::string &name, const std::string &chainId, const map_t &config)
867  : Plugin(name, chainId, config)
868  {}
869 
879  : Plugin(params)
880  {}
881 
882  // This method does not need to show up in doxygen
883  /* Called between construction and start() to set the hostSide field */
884  virtual void setNextTowardsHost(HostSide::ptr_t &&host)
885  {
886  hostSide = std::move(host);
887  }
888 
889 protected:
895 };
896 
912 {
913 public:
914 
929  AbstractSimpleTransport(const std::string &name, const std::string &chainId, const map_t &config)
930  : AbstractTransport(name, chainId, config)
931  {}
932 
942  : AbstractTransport(params)
943  {}
944 
945 
952  {
953  for (Message *it = start; it != end; ++it) {
954  try {
955  if (it->getPayload().empty()) {
957  } else {
959  }
960  } catch (...) {
961  handleException(*it);
962  }
963  }
964  }
966  virtual void deliverMessageTowardsTransport(Message &msg) = 0;
969  {
970  // do nothing
971  }
972 
991  virtual void handleException(Message &m)
992  {
993  try {
994  throw;
995  } catch (const std::exception &e) {
996  logger.warn("Error while delivering message: %s; %s will be dropped.", e.what(), to_string(m).c_str());
997  } catch (...) {
998  logger.warn("Unknown error delivering message: %s", to_string(m).c_str());
999  }
1000  }
1001 };
1002 
1022 {
1023 public:
1038  AbstractSimpleCodec(const std::string &name, const std::string &chainId, const map_t &config)
1039  : AbstractCodec(name, chainId, config)
1040  {}
1041 
1051  : AbstractCodec(params)
1052  {}
1053 
1061  {
1062  Message *curr = start;
1063  for (Message *it = start; it != end; ++it) {
1064  bool rv;
1065  try {
1066  if (it->getPayload().empty()) {
1068  } else {
1069  rv = transformMessageTowardsHost(*it);
1070  }
1071  } catch (...) {
1072  rv = handleException(*it, false);
1073  }
1074  // if we keep it (and it didn't throw) swap it with the accumulator
1075  if (rv) {
1076  if (it != curr) it->swap(std::move(*curr)); // don't self-swap
1077  ++curr;
1078  }
1079  }
1080  if (hostSide.get()) hostSide->sendBatchTowardsHost(start, curr);
1081  }
1089  {
1090  Message *curr = start;
1091  for (Message *it = start; it != end; ++it) {
1092  bool rv;
1093  try {
1094  // process the message
1095  if (it->getPayload().empty()) {
1097  } else {
1099  }
1100  } catch (...) {
1101  rv = handleException(*it, true);
1102  }
1103  // if we keep it (and it didn't throw) swap it with the accumulator
1104  if (rv) {
1105  if (it != curr) it->swap(std::move(*curr)); // don't self-swap
1106  ++curr;
1107  }
1108  }
1109  if (transportSide.get()) transportSide->sendBatchTowardsTransport(start, curr);
1110  }
1111 
1116  virtual bool transformMessageTowardsHost(Message &msg) = 0;
1121  virtual bool transformMessageTowardsTransport(Message &msg) = 0;
1127  {
1128  // do nothing
1129  return true;
1130  }
1136  {
1137  // do nothing
1138  return true;
1139  }
1161  virtual bool handleException(Message &m, bool towardsTransport)
1162  {
1163  try {
1164  throw;
1165  } catch (const std::exception &e) {
1166  logger.warn("Error while transforming message: %s; %s will be dropped.", e.what(), to_string(m).c_str());
1167  } catch (...) {
1168  logger.warn("Unknown error transforming message: %s", to_string(m).c_str());
1169  }
1170  return false;
1171  }
1172 };
1173 
1174 }}} // com.softwareag.connectivity
1175 
1176 // internal implementation included from these files
1177 #include <sag_internal/exception.hpp>
1178 #include <sag_internal/remote_plugins.hpp>
1179 #include <sag_internal/plugin_macros.hpp>
1180 
1190 #define SAG_DECLARE_CONNECTIVITY_TRANSPORT_CLASS(Class) _SAG_DECLARE_CONNECTIVITY_TRANSPORT_CLASS(Class)
1191 
1203 #define SAG_DECLARE_CONNECTIVITY_TRANSPORT(Class) _SAG_DECLARE_CONNECTIVITY_TRANSPORT_LEGACY(Class)
1204 
1214 #define SAG_DECLARE_CONNECTIVITY_CODEC_CLASS(Class) _SAG_DECLARE_CONNECTIVITY_CODEC_CLASS(Class)
1215 
1226 #define SAG_DECLARE_CONNECTIVITY_CODEC(Class) _SAG_DECLARE_CONNECTIVITY_CODEC_LEGACY(Class)
1227 
1228 #endif // _SAG_CONNECTIVITY_PLUGINS_HPP_
A container for parameters passed to the constructor of a codec plug-in.
Definition: sag_connectivity_plugins.hpp:195
Logger LOGGER
Legacy logging for writing to the host log file [DEPRECATED].
Definition: sag_connectivity_plugins.hpp:563
bool empty() const
Returns true if the map is empty (size() == 0)
Definition: sag_connectivity_cpp.hpp:290
const std::string pluginName
The name used for this plug-in in the configuration file.
Definition: sag_connectivity_plugins.hpp:534
Base class that simplifies implementation of codec plug-ins that deal only with individual messages n...
Definition: sag_connectivity_plugins.hpp:1021
AbstractTransport(const PluginConstructorParameters::TransportConstructorParameters &params)
Constructor.
Definition: sag_connectivity_plugins.hpp:878
Base class that simplifies implementation of transport plug-ins that deal only with individual messag...
Definition: sag_connectivity_plugins.hpp:911
void increment(int64_t incrementValue=1)
Set an integer status value by incrementing the previous integer value that was set by this object...
Definition: sag_connectivity_plugins.hpp:303
HostSide::ptr_t hostSide
The next plug-in in the chain towards host.
Definition: sag_connectivity_plugins.hpp:807
An interface to the next component (plugin or host) towards the host.
Definition: sag_connectivity_plugins.hpp:577
virtual void sendBatchTowardsHost(Message *start, Message *end)=0
Abstract method that must be implemented to handle delivery of a batch of messages heading towards th...
map_t config
The configuration of this plug-in.
Definition: sag_connectivity_plugins.hpp:538
item_ptr createStatusItem(const std::string &key, int64_t initialValue)
Creates a StatusItem instance that can be used to report status for a given key, using an integral in...
Definition: sag_connectivity_plugins.hpp:382
Direction
The enumeration indicating the direction of message flow - towards the transport or towards the host...
Definition: sag_connectivity_plugins.hpp:69
void warn(const char *format, ARGS...args) const
Log a message at WARN level.
Definition: sag_plugin_logging.hpp:153
Class for writing to the system logger.
Definition: sag_plugin_logging.hpp:72
const PluginHost::ptr_t host
Interface to support miscellaneous requests from this plug-in to the host system. ...
Definition: sag_connectivity_plugins.hpp:544
StatusReporter & getStatusReporter()
Allows reporting status information from this plug-in, such as online or failed status and number of ...
Definition: sag_connectivity_plugins.hpp:552
Contains the C++ implementation of the underlying datatypes used by connectivity plugins and their ac...
void setStatus(const map_t &statusmap)
Set multiple related string status values at the same time (atomically).
Definition: sag_connectivity_plugins.hpp:399
virtual void sendBatchTowardsTransport(Message *start, Message *end)
Implements batch sending, calling deliverMessageTowardsTransport(Message&) for each message individua...
Definition: sag_connectivity_plugins.hpp:951
Base of the inheritance tree for Connectivity plugins.
Definition: sag_connectivity_plugins.hpp:451
TransportSide::ptr_t transportSide
The next plug-in in the chain towards transport.
Definition: sag_connectivity_plugins.hpp:813
std::unique_ptr< StatusItem > item_ptr
Unique pointer to a StatusItem.
Definition: sag_connectivity_plugins.hpp:350
virtual void sendBatchTowardsTransport(Message *start, Message *end)=0
Abstract method that must be implemented to handle delivery of a batch of messages heading towards th...
void setStatus(const std::string &value)
Set a string status value.
Definition: sag_connectivity_plugins.hpp:268
Definition: sag_connectivity_threading.h:178
AbstractSimpleTransport(const PluginConstructorParameters::TransportConstructorParameters &params)
Constructor.
Definition: sag_connectivity_plugins.hpp:941
Logger logger
Logging for writing to the host log file.
Definition: sag_connectivity_plugins.hpp:568
void info(const char *format, ARGS...args) const
Log a message at INFO level.
Definition: sag_plugin_logging.hpp:155
virtual bool transformNullPayloadTowardsTransport(Message &msg)
Transform a message with a null payload in a transport-wards direction.
Definition: sag_connectivity_plugins.hpp:1135
virtual void start()
Called when an entire chain has been created and the plugin is allowed to start up (after all plugins...
Definition: sag_connectivity_plugins.hpp:491
auto sendBatchTowardsTransport(const IT &begin, const IT &end) -> typename std::enable_if< !std::is_const< ampl::remove_ref_t< decltype(*begin)>>::value &&ampl::is_same< Message, ampl::remove_const_t< ampl::remove_ref_t< decltype(*begin)>>>::value, void >::type
Overload for sending messages using an iterator range.
Definition: sag_connectivity_plugins.hpp:705
std::enable_if< get_underlying< T >::value, std::string >::type to_string(const T &t)
Get a string representation of t.
A class allowing a plug-in to report status values to the host.
Definition: sag_connectivity_plugins.hpp:226
std::unique_ptr< TransportSide > ptr_t
Pointers to TransportSides should always be this ptr_t type, which is a std::unique_ptr.
Definition: sag_connectivity_plugins.hpp:661
size_t erase(const data_t &k)
Remove the item with the specified key.
virtual ~TransportSide()
Ensure virtual destruction.
Definition: sag_connectivity_plugins.hpp:659
Base class for transport plug-ins.
Definition: sag_connectivity_plugins.hpp:847
static const char * STATUS_ONLINE()
Returns a constant that should be used as the status value when a component is online, operational, connected, and ready to handles messages.
Definition: sag_connectivity_plugins.hpp:233
item_ptr createStatusItem(const std::string &key, const std::string &initialValue)
Creates a StatusItem instance that can be used to report status for a given key.
Definition: sag_connectivity_plugins.hpp:365
const_iterator cbegin() const
Forward const_iterator begin.
Definition: sag_connectivity_cpp.hpp:282
AbstractSimpleTransport(const std::string &name, const std::string &chainId, const map_t &config)
Legacy constructor [DEPRECATED].
Definition: sag_connectivity_plugins.hpp:929
bool isShuttingDown()
Check if host is shutting down.
Definition: sag_connectivity_plugins.hpp:111
const_iterator cend() const
Forward const_iterator end.
Definition: sag_connectivity_cpp.hpp:284
virtual void handleException(Message &m)
Handle an exception thrown while delivering a message towards the transport.
Definition: sag_connectivity_plugins.hpp:991
const std::string name
The name used for this plug-in in the configuration file.
Definition: sag_connectivity_plugins.hpp:530
static const char * STATUS_FAILED()
Returns a constant that should be used as the status value when a component is not currently operatio...
Definition: sag_connectivity_plugins.hpp:241
virtual ~HostSide()
Ensure virtual destruction.
Definition: sag_connectivity_plugins.hpp:581
AbstractSimpleCodec(const PluginConstructorParameters::CodecConstructorParameters &params)
Constructor.
Definition: sag_connectivity_plugins.hpp:1050
virtual void hostReady()
Called some time after start(), when the host is ready to start receiving input (sends will be queued...
Definition: sag_connectivity_plugins.hpp:500
Base class for codec plug-ins.
Definition: sag_connectivity_plugins.hpp:755
No error.
Definition: sag_connectivity_c.h:64
void sendBatchTowardsHost(Message &&message)
Overload for sending a batch containing a single message.
Definition: sag_connectivity_plugins.hpp:612
static const char * STATUS_STARTING()
Returns a constant that should be used as the status value when a component is still starting...
Definition: sag_connectivity_plugins.hpp:237
virtual bool transformMessageTowardsTransport(Message &msg)=0
Abstract method that must be implemented to handle transformation of an individual message in a trans...
std::pair< iterator, bool > insert(insertion_t &&v)
Insert a new key/value pair into the map.
AbstractSimpleCodec(const std::string &name, const std::string &chainId, const map_t &config)
Legacy constructor [DEPRECATED].
Definition: sag_connectivity_plugins.hpp:1038
void setStatus(int64_t value)
Set an integer status value.
Definition: sag_connectivity_plugins.hpp:282
virtual bool transformMessageTowardsHost(Message &msg)=0
Abstract method that must be implemented to handle transformation of an individual message...
A map class which implements many of the functions on std::map.
Definition: sag_connectivity_cpp.hpp:36
const std::string & key()
Get the unique key specified when this status item was created.
Definition: sag_connectivity_plugins.hpp:312
const std::string & getPluginName() const
Get the name used in the configuration file for this plug-in.
Definition: sag_connectivity_plugins.hpp:162
A class that can be used to efficiently update the value associated with a single status key...
Definition: sag_connectivity_plugins.hpp:252
A container for an payload and associated metadata.
Definition: sag_connectivity_cpp.hpp:27
virtual void shutdown()
Stop processing messages and terminate and join any background threads.
Definition: sag_connectivity_plugins.hpp:524
virtual void sendBatchTowardsHost(Message *start, Message *end)
Implements batch sending, calling transformMessageTowardsHost(Message &) for each message individuall...
Definition: sag_connectivity_plugins.hpp:1060
An interface to the next component (plugin or host) towards the transport.
Definition: sag_connectivity_plugins.hpp:655
AbstractCodec(const PluginConstructorParameters::CodecConstructorParameters &params)
Constructor.
Definition: sag_connectivity_plugins.hpp:787
virtual void deliverMessageTowardsTransport(Message &msg)=0
Abstract method that must be implemented to handle delivery of an individual message.
auto sendBatchTowardsHost(const IT &begin, const IT &end) -> typename std::enable_if< !std::is_const< ampl::remove_ref_t< decltype(*begin)>>::value &&ampl::is_same< Message, ampl::remove_const_t< ampl::remove_ref_t< decltype(*begin)>>>::value, void >::type
Overload for sending messages using an iterator range.
Definition: sag_connectivity_plugins.hpp:626
virtual void deliverNullPayloadTowardsTransport(Message &msg)
Deliver a message with a null payload.
Definition: sag_connectivity_plugins.hpp:968
void enableReliability(Direction direction)
Enable reliable messaging for the chain that this plug-in belongs to, in a particular direction i...
Definition: sag_connectivity_plugins.hpp:104
Contains the headers needed to implement your own Connectivity Plugins.
AbstractCodec(const std::string &pluginName, const std::string &chainId, const map_t &config)
Legacy constructor [DEPRECATED].
Definition: sag_connectivity_plugins.hpp:775
A container for parameters passed to the constructor of a transport plug-in.
Definition: sag_connectivity_plugins.hpp:183
The direction of messages flowing towards the host (from the transport).
AbstractTransport(const std::string &name, const std::string &chainId, const map_t &config)
Legacy constructor [DEPRECATED].
Definition: sag_connectivity_plugins.hpp:866
const std::string & getChainId() const
Get the identifier used for the chain this plug-in is part of.
Definition: sag_connectivity_plugins.hpp:157
Interface to support miscellaneous requests from a particular plug-in to the host system...
Definition: sag_connectivity_plugins.hpp:85
A base interface for parameters passed to the constructor of transport or codec plug-ins.
Definition: sag_connectivity_plugins.hpp:138
Plugin(const std::string &pluginName, const std::string &chainId, const map_t &config)
Legacy constructor [DEPRECATED].
Definition: sag_connectivity_plugins.hpp:457
virtual bool handleException(Message &m, bool towardsTransport)
Handle an exception thrown while delivering a message.
Definition: sag_connectivity_plugins.hpp:1161
utf8-encoded const char*
Definition: sag_connectivity_c.h:46
const std::string chainId
The identifier used for the chain this plug-in is part of.
Definition: sag_connectivity_plugins.hpp:536
The direction of messages flowing towards the transport (from the host).
void sendBatchTowardsTransport(Message &&message)
Overload for sending a batch containing a single message.
Definition: sag_connectivity_plugins.hpp:691
std::string getStatus()
Return the value this status item was set to most recently by this class.
Definition: sag_connectivity_plugins.hpp:294
A variant type which can be one of the following:
Definition: sag_connectivity_cpp.hpp:42
std::unique_ptr< HostSide > ptr_t
Pointers to HostSides should always be this ptr_t type, which is a std::unique_ptr.
Definition: sag_connectivity_plugins.hpp:583
const map_t & getConfig() const
Get the configuration for this plug-in.
Definition: sag_connectivity_plugins.hpp:152
virtual void sendBatchTowardsTransport(Message *start, Message *end)
Implements batch sending, calling transformMessageTowardsTransport(Message &) for each message indivi...
Definition: sag_connectivity_plugins.hpp:1088
virtual ~Plugin()
This destructor must be virtual.
Definition: sag_connectivity_plugins.hpp:479
HostSide::ptr_t hostSide
The next plug-in in the chain towards host.
Definition: sag_connectivity_plugins.hpp:894
const std::string & getName() const
The name used for this plug-in in the configuration file.
Definition: sag_connectivity_plugins.hpp:526
virtual bool transformNullPayloadTowardsHost(Message &msg)
Transform a message with a null payload in a host-wards direction.
Definition: sag_connectivity_plugins.hpp:1126