aboutsummaryrefslogtreecommitdiff
path: root/libcmix-common/senderreceiver.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'libcmix-common/senderreceiver.hpp')
-rw-r--r--libcmix-common/senderreceiver.hpp18
1 files changed, 17 insertions, 1 deletions
diff --git a/libcmix-common/senderreceiver.hpp b/libcmix-common/senderreceiver.hpp
index 9a07f78..c7fed3a 100644
--- a/libcmix-common/senderreceiver.hpp
+++ b/libcmix-common/senderreceiver.hpp
@@ -6,12 +6,28 @@
#include "protobufclient.hpp"
+/*!
+ * \file
+ */
+
+/*!
+ * \brief The SenderReciever struct is a shim around ProtobufClient and only exposes things needed
+ * for Sending and Receiving messages.
+ */
struct SenderReceiver : private ProtobufClient<CMixProtoFunctor>
{
+ /*!
+ * \brief SenderReceiver Explicit conversion to SenderReceiver
+ * \param r The Receiver to upgrade
+ */
explicit SenderReceiver(Receiver&& r);
+ /*!
+ * \brief SenderReceiver Explicit conversion to SenderReceiver
+ * \param s The Sender to upgrade
+ */
explicit SenderReceiver(Sender&& s);
-
+
using ProtobufClient::ProtobufClient;
using ProtobufClient::async_receive;