17 #ifndef _SAG_CONNECTIVITY_PLUGINS_HPP_ 18 #define _SAG_CONNECTIVITY_PLUGINS_HPP_ 26 #ifndef __STDC_FORMAT_MACROS 27 #define __STDC_FORMAT_MACROS 1 32 namespace softwareag {
33 namespace _DATAT_INTERNAL_CPP_NAMESPACE {
40 void replace(std::string &input,
const std::string &from,
const std::string &to)
43 while((pos = input.find(from, pos)) != std::string::npos)
45 input.replace(pos, from.length(), to);
53 std::string
to_string(
const Message &m,
bool truncate=
true)
55 std::string payload =
to_string(m.getPayload());
56 if (truncate && payload.length() > 200) payload = payload.substr(0, 196) +
" ...";
58 replace(payload,
"\n",
"\\n");
59 replace(payload,
"\r",
"\\r");
60 return "Message<metadata="+
to_string(m.getMetadataMap())+
", payload="+payload+
">";
88 typedef std::unique_ptr<PluginHost> ptr_t;
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");
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");
116 return isShuttingDown;
122 PluginHost(
void* chain =
nullptr) :chain(chain) {}
169 : chainId(chainId), pluginName(pluginName), config(config.copy()), connectivityManager(connectivityManager), chain(chain)
174 std::string pluginName;
177 void* connectivityManager;
259 sag_delete_user_status_item(connectivityManager, underlying);
260 underlying.item =
nullptr;
270 std::unique_lock<std::mutex> ul(status_lock);
271 setStatusLocked(value);
284 std::unique_lock<std::mutex> ul(status_lock);
286 setStatusLocked(convert_to_details::integerToString(value));
305 std::unique_lock<std::mutex> ul(status_lock);
306 intValue += incrementValue;
307 setStatusLocked(convert_to_details::integerToString(intValue));
312 const std::string &
key() {
return mkey; }
318 StatusItem(
void* connectivityManager,
const std::string &key,
const std::string &initialValue,
const int64_t intValue)
319 : intValue(intValue),
321 lastValue(initialValue),
322 connectivityManager(connectivityManager),
323 underlying(sag_create_user_status_item(connectivityManager, key.c_str(), initialValue.c_str()))
325 if (!underlying.item)
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());
333 void setStatusLocked(
const std::string &value)
335 if (value == lastValue)
return;
338 sag_set_user_status_item(underlying, value.c_str());
342 const std::string mkey;
343 std::string lastValue;
344 void* connectivityManager;
345 sag_status_item_t underlying;
346 std::mutex status_lock;
368 return std::unique_ptr<StatusItem>(
new StatusItem(connectivityManager, key, initialValue, 0));
386 std::ostringstream oss;
388 return std::unique_ptr<StatusItem>(
new StatusItem(connectivityManager, key, oss.str(), initialValue));
404 sag_set_user_status_map(connectivityManager, reinterpret_cast<const sag_underlying_map_t&>(statusmap));
406 for (
auto it = statusmap.
cbegin(); it != statusmap.
cend(); it++)
409 if (it->second.empty())
410 mapKeysToCleanup.erase(it->first);
412 mapKeysToCleanup.insert(it->first.copy(),
data_t());
423 if (!mapKeysToCleanup.empty())
424 sag_set_user_status_map(connectivityManager, reinterpret_cast<const sag_underlying_map_t&>(mapKeysToCleanup));
430 explicit StatusReporter(
void *connectivityManager) : connectivityManager(connectivityManager), mapKeysToCleanup()
435 void* connectivityManager;
436 map_t mapKeysToCleanup;
439 StatusReporter() =
delete;
442 StatusReporter(
const StatusReporter& other) =
delete;
443 StatusReporter& operator=(
const StatusReporter&) =
delete;
462 host(
new PluginHost(params.chain)), logger(
"connectivity." + pluginName +
"." + chainId),
519 const std::string &
getName()
const {
return pluginName; }
543 if (statusReporter)
return *statusReporter;
544 throw std::runtime_error(
"Cannot call getStatusReporter when using the legacy constructor");
553 std::unique_ptr<StatusReporter> statusReporter;
566 typedef std::unique_ptr<HostSide>
ptr_t;
586 virtual void sendBatchTowardsHost(
Message *start,
Message *end) = 0;
596 sendBatchTowardsHost(&message, &message+1);
609 template<
typename IT>
611 !std::is_const<ampl::remove_ref_t<decltype(*begin)>>::value &&
612 ampl::is_same<
Message, ampl::remove_const_t<ampl::remove_ref_t<decltype(*begin)>>>::value
615 if(begin == end) sendBatchTowardsHost((
Message*)
nullptr, (
Message*)
nullptr);
616 else sendBatchTowardsHost(&(*begin), (&(*(end-1)))+1);
624 class RemoteHostSide:
public HostSide
627 RemoteHostSide(sag_plugin_t other, sag_send_fn_t fn): other(other), fn(fn) {}
628 virtual ~RemoteHostSide() {}
629 virtual void sendBatchTowardsHost(Message *start, Message *end);
645 typedef std::unique_ptr<TransportSide>
ptr_t;
666 virtual void sendBatchTowardsTransport(
Message *start,
Message *end) = 0;
676 sendBatchTowardsTransport(&message, &message+1);
688 template<
typename IT>
690 !std::is_const<ampl::remove_ref_t<decltype(*begin)>>::value &&
691 ampl::is_same<
Message, ampl::remove_const_t<ampl::remove_ref_t<decltype(*begin)>>>::value
694 if(begin == end) sendBatchTowardsTransport((
Message*)
nullptr, (
Message*)
nullptr);
695 else sendBatchTowardsTransport(&(*begin), (&(*(end-1)))+1);
703 class RemoteTransportSide:
public TransportSide
706 RemoteTransportSide(sag_plugin_t other, sag_send_fn_t fn): other(other), fn(fn) {}
707 virtual ~RemoteTransportSide() {}
708 virtual void sendBatchTowardsTransport(Message *start, Message *end);
757 hostSide = std::move(host);
760 virtual void setNextTowardsTransport(TransportSide::ptr_t &&transport)
762 transportSide = std::move(transport);
827 hostSide = std::move(host);
873 for (
Message *it = start; it != end; ++it) {
875 if (it->getPayload().empty()) {
876 deliverNullPayloadTowardsTransport(*it);
878 deliverMessageTowardsTransport(*it);
881 handleException(*it);
886 virtual void deliverMessageTowardsTransport(
Message &msg) = 0;
915 }
catch (
const std::exception &e) {
916 logger.warn(
"Error while delivering message: %s; %s will be dropped.", e.what(),
to_string(m).c_str());
918 logger.warn(
"Unknown error delivering message: %s",
to_string(m).c_str());
963 for (
Message *it = start; it != end; ++it) {
966 if (it->getPayload().empty()) {
967 rv = transformNullPayloadTowardsHost(*it);
969 rv = transformMessageTowardsHost(*it);
972 rv = handleException(*it,
false);
976 if (it != curr) it->swap(std::move(*curr));
980 if (hostSide.get()) hostSide->sendBatchTowardsHost(start, curr);
991 for (
Message *it = start; it != end; ++it) {
995 if (it->getPayload().empty()) {
996 rv = transformNullPayloadTowardsTransport(*it);
998 rv = transformMessageTowardsTransport(*it);
1001 rv = handleException(*it,
true);
1005 if (it != curr) it->swap(std::move(*curr));
1009 if (transportSide.get()) transportSide->sendBatchTowardsTransport(start, curr);
1016 virtual bool transformMessageTowardsHost(
Message &msg) = 0;
1021 virtual bool transformMessageTowardsTransport(
Message &msg) = 0;
1065 }
catch (
const std::exception &e) {
1066 logger.warn(
"Error while transforming message: %s; %s will be dropped.", e.what(),
to_string(m).c_str());
1068 logger.warn(
"Unknown error transforming message: %s",
to_string(m).c_str());
1076 namespace connectivity {
using namespace _DATAT_INTERNAL_CPP_NAMESPACE; }
1081 #include <sag_internal/exception.hpp> 1082 #include <sag_internal/remote_plugins.hpp> 1083 #include <sag_internal/plugin_macros.hpp> 1094 #define SAG_DECLARE_CONNECTIVITY_TRANSPORT_CLASS(Class) _SAG_DECLARE_CONNECTIVITY_TRANSPORT_CLASS(Class) 1105 #define SAG_DECLARE_CONNECTIVITY_CODEC_CLASS(Class) _SAG_DECLARE_CONNECTIVITY_CODEC_CLASS(Class) 1107 #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:524
Base class that simplifies implementation of codec plug-ins that deal only with individual messages n...
Definition: sag_connectivity_plugins.hpp:938
AbstractTransport(const PluginConstructorParameters::TransportConstructorParameters ¶ms)
Constructor.
Definition: sag_connectivity_plugins.hpp:819
Base class that simplifies implementation of transport plug-ins that deal only with individual messag...
Definition: sag_connectivity_plugins.hpp:849
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:769
An interface to the next component (plugin or host) towards the host.
Definition: sag_connectivity_plugins.hpp:560
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:528
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:534
StatusReporter & getStatusReporter()
Allows reporting status information from this plug-in, such as online or failed status and number of ...
Definition: sag_connectivity_plugins.hpp:542
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:871
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:775
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 ¶ms)
Constructor.
Definition: sag_connectivity_plugins.hpp:861
Logger logger
Logging for writing to the host log file.
Definition: sag_connectivity_plugins.hpp:551
virtual bool transformNullPayloadTowardsTransport(Message &msg)
Transform a message with a null payload in a transport-wards direction.
Definition: sag_connectivity_plugins.hpp:1035
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 &&l::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:689
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:645
virtual ~TransportSide()
Ensure virtual destruction.
Definition: sag_connectivity_plugins.hpp:643
Base class for transport plug-ins.
Definition: sag_connectivity_plugins.hpp:806
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:519
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:911
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:564
AbstractSimpleCodec(const PluginConstructorParameters::CodecConstructorParameters ¶ms)
Constructor.
Definition: sag_connectivity_plugins.hpp:950
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:736
void sendBatchTowardsHost(Message &&message)
Overload for sending a batch containing a single message.
Definition: sag_connectivity_plugins.hpp:595
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:517
virtual void sendBatchTowardsHost(Message *start, Message *end)
Implements batch sending, calling transformMessageTowardsHost(Message &) for each message individuall...
Definition: sag_connectivity_plugins.hpp:960
An interface to the next component (plugin or host) towards the transport.
Definition: sag_connectivity_plugins.hpp:639
AbstractCodec(const PluginConstructorParameters::CodecConstructorParameters ¶ms)
Constructor.
Definition: sag_connectivity_plugins.hpp:749
auto sendBatchTowardsHost(const IT &begin, const IT &end) -> typename std::enable_if< !std::is_const< ampl::remove_ref_t< decltype(*begin)>>::value &&l::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:610
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:888
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:1061
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:526
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:675
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:566
virtual void sendBatchTowardsTransport(Message *start, Message *end)
Implements batch sending, calling transformMessageTowardsTransport(Message &) for each message indivi...
Definition: sag_connectivity_plugins.hpp:988
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:835
virtual bool transformNullPayloadTowardsHost(Message &msg)
Transform a message with a null payload in a host-wards direction.
Definition: sag_connectivity_plugins.hpp:1026