Apama  10.7.1.2
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-2021 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 389888 2021-05-04 13:52:55Z hdy $
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 _DATAT_INTERNAL_CPP_NAMESPACE {
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 
366  item_ptr createStatusItem(const std::string &key, const std::string &initialValue)
367  {
368  return std::unique_ptr<StatusItem>(new StatusItem(connectivityManager, key, initialValue, 0));
369  }
370 
384  item_ptr createStatusItem(const std::string &key, int64_t initialValue)
385  {
386  std::ostringstream oss;
387  oss << initialValue;
388  return std::unique_ptr<StatusItem>(new StatusItem(connectivityManager, key, oss.str(), initialValue));
389  }
390 
402  void setStatus(const map_t &statusmap)
403  {
404  sag_set_user_status_map(connectivityManager, reinterpret_cast<const sag_underlying_map_t&>(statusmap));
405  // keep track of what keys we've added so we can automatically remove them when we're destroyed
406  for (auto it = statusmap.cbegin(); it != statusmap.cend(); it++)
407  if (it->first.type_tag() == SAG_DATA_STRING) // ignore invalid ones
408  {
409  if (it->second.empty())
410  mapKeysToCleanup.erase(it->first);
411  else
412  mapKeysToCleanup.insert(it->first.copy(), data_t());
413  }
414  }
415 
416 
417 
421  ~StatusReporter()
422  {
423  if (!mapKeysToCleanup.empty())
424  sag_set_user_status_map(connectivityManager, reinterpret_cast<const sag_underlying_map_t&>(mapKeysToCleanup));
425  }
426 
430  explicit StatusReporter(void *connectivityManager) : connectivityManager(connectivityManager), mapKeysToCleanup()
431  {
432  }
433 
434 private:
435  void* connectivityManager;
436  map_t mapKeysToCleanup;
437 
438 
439  StatusReporter() = delete;
440 
441  // non-copyable, due to the cleanup code we don't want people to shoot themselves in the foot by having multiple copies
442  StatusReporter(const StatusReporter& other) = delete;
443  StatusReporter& operator=(const StatusReporter&) = delete;
444 
445 };
446 
454 class Plugin
455 {
456 public:
457  /* Constructor.
458  * @since 9.12.0.1
459  */
460  Plugin(const PluginConstructorParameters &params)
461  : pluginName(params.getPluginName()), chainId(params.getChainId()), config(params.getConfig().copy()),
462  host(new PluginHost(params.chain)), logger("connectivity." + pluginName + "." + chainId),
463  statusReporter(new StatusReporter(params.connectivityManager))
464  {
465  }
466 
472  virtual ~Plugin() {}
473 
484  virtual void start() {}
485 
493  virtual void hostReady() {}
494 
519  virtual void shutdown() {}
521  const std::string &getName() const { return pluginName; }
522 protected:
526  const std::string pluginName;
528  const std::string chainId;
536  const PluginHost::ptr_t host;
545  if (statusReporter) return *statusReporter;
546  throw std::runtime_error("Cannot call getStatusReporter when using the legacy constructor");
547  }
548 
549 public:
554 private:
555  std::unique_ptr<StatusReporter> statusReporter;
556 };
557 
562 class HostSide
563 {
564 public:
566  virtual ~HostSide() {}
568  typedef std::unique_ptr<HostSide> ptr_t;
588  virtual void sendBatchTowardsHost(Message *start, Message *end) = 0;
589 
597  void sendBatchTowardsHost(Message &&message) {
598  sendBatchTowardsHost(&message, &message+1);
599  }
600 
611  template<typename IT>
612  auto sendBatchTowardsHost(const IT &begin, const IT &end) -> typename std::enable_if<
613  !std::is_const<ampl::remove_ref_t<decltype(*begin)>>::value &&
614  ampl::is_same<Message, ampl::remove_const_t<ampl::remove_ref_t<decltype(*begin)>>>::value
615  , void>::type // this ensures we can only pass in non-const iterator pairs to Message
616  {
617  if(begin == end) sendBatchTowardsHost((Message*) nullptr, (Message*) nullptr);
618  else sendBatchTowardsHost(&(*begin), (&(*(end-1)))+1);
619  }
620 };
621 
626 class RemoteHostSide: public HostSide
627 {
628 public:
629  RemoteHostSide(sag_plugin_t other, sag_send_fn_t fn): other(other), fn(fn) {}
630  virtual ~RemoteHostSide() {}
631  virtual void sendBatchTowardsHost(Message *start, Message *end);
632 private:
633  sag_plugin_t other;
634  sag_send_fn_t fn;
635 };
636 
642 {
643 public:
645  virtual ~TransportSide() {}
647  typedef std::unique_ptr<TransportSide> ptr_t;
668  virtual void sendBatchTowardsTransport(Message *start, Message *end) = 0;
669 
678  sendBatchTowardsTransport(&message, &message+1);
679  }
680 
690  template<typename IT>
691  auto sendBatchTowardsTransport(const IT &begin, const IT &end) -> typename std::enable_if<
692  !std::is_const<ampl::remove_ref_t<decltype(*begin)>>::value &&
693  ampl::is_same<Message, ampl::remove_const_t<ampl::remove_ref_t<decltype(*begin)>>>::value
694  , void>::type // this ensures we can only pass in non-const iterator pairs to Message
695  {
696  if(begin == end) sendBatchTowardsTransport((Message*) nullptr, (Message*) nullptr);
697  else sendBatchTowardsTransport(&(*begin), (&(*(end-1)))+1);
698  }
699 };
700 
705 class RemoteTransportSide: public TransportSide
706 {
707 public:
708  RemoteTransportSide(sag_plugin_t other, sag_send_fn_t fn): other(other), fn(fn) {}
709  virtual ~RemoteTransportSide() {}
710  virtual void sendBatchTowardsTransport(Message *start, Message *end);
711 private:
712  sag_plugin_t other;
713  sag_send_fn_t fn;
714 };
715 
716 
738 class AbstractCodec: public Plugin, public HostSide, public TransportSide
739 {
740 public:
742 
752  : Plugin(params)
753  {}
754 
755  // These methods do not need to show up in doxygen
756  /* Called between construction and start() to set the hostSide field */
757  virtual void setNextTowardsHost(HostSide::ptr_t &&host)
758  {
759  hostSide = std::move(host);
760  }
761  /* Called between construction and start() to set the transportSide field */
762  virtual void setNextTowardsTransport(TransportSide::ptr_t &&transport)
763  {
764  transportSide = std::move(transport);
765  }
766 protected:
772 
778 };
779 
809 {
810 public:
812 
822  : Plugin(params)
823  {}
824 
825  // This method does not need to show up in doxygen
826  /* Called between construction and start() to set the hostSide field */
827  virtual void setNextTowardsHost(HostSide::ptr_t &&host)
828  {
829  hostSide = std::move(host);
830  }
831 
832 protected:
838 };
839 
852 {
853 public:
854 
864  : AbstractTransport(params)
865  {}
866 
867 
873  virtual void sendBatchTowardsTransport(Message *start, Message *end)
874  {
875  for (Message *it = start; it != end; ++it) {
876  try {
877  if (it->getPayload().empty()) {
878  deliverNullPayloadTowardsTransport(*it);
879  } else {
880  deliverMessageTowardsTransport(*it);
881  }
882  } catch (...) {
883  handleException(*it);
884  }
885  }
886  }
888  virtual void deliverMessageTowardsTransport(Message &msg) = 0;
891  {
892  // do nothing
893  }
894 
913  virtual void handleException(Message &m)
914  {
915  try {
916  throw;
917  } catch (const std::exception &e) {
918  logger.warn("Error while delivering message: %s; %s will be dropped.", e.what(), to_string(m).c_str());
919  } catch (...) {
920  logger.warn("Unknown error delivering message: %s", to_string(m).c_str());
921  }
922  }
923 };
924 
941 {
942 public:
943 
953  : AbstractCodec(params)
954  {}
955 
962  virtual void sendBatchTowardsHost(Message *start, Message *end)
963  {
964  Message *curr = start;
965  for (Message *it = start; it != end; ++it) {
966  bool rv;
967  try {
968  if (it->getPayload().empty()) {
969  rv = transformNullPayloadTowardsHost(*it);
970  } else {
971  rv = transformMessageTowardsHost(*it);
972  }
973  } catch (...) {
974  rv = handleException(*it, false);
975  }
976  // if we keep it (and it didn't throw) swap it with the accumulator
977  if (rv) {
978  if (it != curr) it->swap(std::move(*curr)); // don't self-swap
979  ++curr;
980  }
981  }
982  if (hostSide.get()) hostSide->sendBatchTowardsHost(start, curr);
983  }
990  virtual void sendBatchTowardsTransport(Message *start, Message *end)
991  {
992  Message *curr = start;
993  for (Message *it = start; it != end; ++it) {
994  bool rv;
995  try {
996  // process the message
997  if (it->getPayload().empty()) {
998  rv = transformNullPayloadTowardsTransport(*it);
999  } else {
1000  rv = transformMessageTowardsTransport(*it);
1001  }
1002  } catch (...) {
1003  rv = handleException(*it, true);
1004  }
1005  // if we keep it (and it didn't throw) swap it with the accumulator
1006  if (rv) {
1007  if (it != curr) it->swap(std::move(*curr)); // don't self-swap
1008  ++curr;
1009  }
1010  }
1011  if (transportSide.get()) transportSide->sendBatchTowardsTransport(start, curr);
1012  }
1013 
1018  virtual bool transformMessageTowardsHost(Message &msg) = 0;
1023  virtual bool transformMessageTowardsTransport(Message &msg) = 0;
1029  {
1030  // do nothing
1031  return true;
1032  }
1038  {
1039  // do nothing
1040  return true;
1041  }
1063  virtual bool handleException(Message &m, bool towardsTransport)
1064  {
1065  try {
1066  throw;
1067  } catch (const std::exception &e) {
1068  logger.warn("Error while transforming message: %s; %s will be dropped.", e.what(), to_string(m).c_str());
1069  } catch (...) {
1070  logger.warn("Unknown error transforming message: %s", to_string(m).c_str());
1071  }
1072  return false;
1073  }
1074 };
1075 
1076 }
1077 
1078 namespace connectivity { using namespace _DATAT_INTERNAL_CPP_NAMESPACE; }
1079 
1080 }} // com.softwareag.connectivity
1081 
1082 // internal implementation included from these files
1083 #include <sag_internal/exception.hpp>
1084 #include <sag_internal/remote_plugins.hpp>
1085 #include <sag_internal/plugin_macros.hpp>
1086 
1096 #define SAG_DECLARE_CONNECTIVITY_TRANSPORT_CLASS(Class) _SAG_DECLARE_CONNECTIVITY_TRANSPORT_CLASS(Class)
1097 
1107 #define SAG_DECLARE_CONNECTIVITY_CODEC_CLASS(Class) _SAG_DECLARE_CONNECTIVITY_CODEC_CLASS(Class)
1108 
1109 #endif // _SAG_CONNECTIVITY_PLUGINS_HPP_
A container for parameters passed to the constructor of a codec plug-in.
Definition: sag_connectivity_plugins.hpp:195
const std::string pluginName
The name used for this plug-in in the configuration file.
Definition: sag_connectivity_plugins.hpp:526
Base class that simplifies implementation of codec plug-ins that deal only with individual messages n...
Definition: sag_connectivity_plugins.hpp:940
AbstractTransport(const PluginConstructorParameters::TransportConstructorParameters &params)
Constructor.
Definition: sag_connectivity_plugins.hpp:821
Base class that simplifies implementation of transport plug-ins that deal only with individual messag...
Definition: sag_connectivity_plugins.hpp:851
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:771
An interface to the next component (plugin or host) towards the host.
Definition: sag_connectivity_plugins.hpp:562
const_iterator cbegin() const
Forward const_iterator begin.
Definition: sag_connectivity_cpp.hpp:314
map_t config
The configuration of this plug-in.
Definition: sag_connectivity_plugins.hpp:530
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:384
Direction
The enumeration indicating the direction of message flow - towards the transport or towards the host.
Definition: sag_connectivity_plugins.hpp:69
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:536
StatusReporter & getStatusReporter()
Allows reporting status information from this plug-in, such as online or failed status and number of ...
Definition: sag_connectivity_plugins.hpp:544
const_iterator cend() const
Forward const_iterator end.
Definition: sag_connectivity_cpp.hpp:316
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:402
virtual void sendBatchTowardsTransport(Message *start, Message *end)
Implements batch sending, calling deliverMessageTowardsTransport(Message&) for each message individua...
Definition: sag_connectivity_plugins.hpp:873
Base of the inheritance tree for Connectivity plugins.
Definition: sag_connectivity_plugins.hpp:454
TransportSide::ptr_t transportSide
The next plug-in in the chain towards transport.
Definition: sag_connectivity_plugins.hpp:777
std::unique_ptr< StatusItem > item_ptr
Unique pointer to a StatusItem.
Definition: sag_connectivity_plugins.hpp:350
void setStatus(const std::string &value)
Set a string status value.
Definition: sag_connectivity_plugins.hpp:268
AbstractSimpleTransport(const PluginConstructorParameters::TransportConstructorParameters &params)
Constructor.
Definition: sag_connectivity_plugins.hpp:863
Logger logger
Logging for writing to the host log file.
Definition: sag_connectivity_plugins.hpp:553
virtual bool transformNullPayloadTowardsTransport(Message &msg)
Transform a message with a null payload in a transport-wards direction.
Definition: sag_connectivity_plugins.hpp:1037
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:484
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:691
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:647
virtual ~TransportSide()
Ensure virtual destruction.
Definition: sag_connectivity_plugins.hpp:645
Base class for transport plug-ins.
Definition: sag_connectivity_plugins.hpp:808
static const char * STATUS_ONLINE()
Returns a constant that should be used as the status value when a component is online,...
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:366
const std::string & getName() const
The name used for this plug-in in the configuration file.
Definition: sag_connectivity_plugins.hpp:521
bool isShuttingDown()
Check if host is shutting down.
Definition: sag_connectivity_plugins.hpp:111
virtual void handleException(Message &m)
Handle an exception thrown while delivering a message towards the transport.
Definition: sag_connectivity_plugins.hpp:913
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:566
AbstractSimpleCodec(const PluginConstructorParameters::CodecConstructorParameters &params)
Constructor.
Definition: sag_connectivity_plugins.hpp:952
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:493
Base class for codec plug-ins.
Definition: sag_connectivity_plugins.hpp:738
void sendBatchTowardsHost(Message &&message)
Overload for sending a batch containing a single message.
Definition: sag_connectivity_plugins.hpp:597
const std::string & getPluginName() const
Get the name used in the configuration file for this plug-in.
Definition: sag_connectivity_plugins.hpp:162
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
void setStatus(int64_t value)
Set an integer status value.
Definition: sag_connectivity_plugins.hpp:282
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
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:519
virtual void sendBatchTowardsHost(Message *start, Message *end)
Implements batch sending, calling transformMessageTowardsHost(Message &) for each message individuall...
Definition: sag_connectivity_plugins.hpp:962
An interface to the next component (plugin or host) towards the transport.
Definition: sag_connectivity_plugins.hpp:641
AbstractCodec(const PluginConstructorParameters::CodecConstructorParameters &params)
Constructor.
Definition: sag_connectivity_plugins.hpp:751
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:612
map_t copy() const
Return a deep copy of this map.
Definition: sag_connectivity_cpp.hpp:243
virtual void deliverNullPayloadTowardsTransport(Message &msg)
Deliver a message with a null payload.
Definition: sag_connectivity_plugins.hpp:890
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.
const std::string & getChainId() const
Get the identifier used for the chain this plug-in is part of.
Definition: sag_connectivity_plugins.hpp:157
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).
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
virtual bool handleException(Message &m, bool towardsTransport)
Handle an exception thrown while delivering a message.
Definition: sag_connectivity_plugins.hpp:1063
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:528
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:677
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:568
virtual void sendBatchTowardsTransport(Message *start, Message *end)
Implements batch sending, calling transformMessageTowardsTransport(Message &) for each message indivi...
Definition: sag_connectivity_plugins.hpp:990
const map_t & getConfig() const
Get the configuration for this plug-in.
Definition: sag_connectivity_plugins.hpp:152
virtual ~Plugin()
This destructor must be virtual.
Definition: sag_connectivity_plugins.hpp:472
HostSide::ptr_t hostSide
The next plug-in in the chain towards host.
Definition: sag_connectivity_plugins.hpp:837
virtual bool transformNullPayloadTowardsHost(Message &msg)
Transform a message with a null payload in a host-wards direction.
Definition: sag_connectivity_plugins.hpp:1028