aboutsummaryrefslogtreecommitdiff
path: root/libcmix-common/receiver.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'libcmix-common/receiver.hpp')
-rw-r--r--libcmix-common/receiver.hpp11
1 files changed, 11 insertions, 0 deletions
diff --git a/libcmix-common/receiver.hpp b/libcmix-common/receiver.hpp
index a70cde0..2b05790 100644
--- a/libcmix-common/receiver.hpp
+++ b/libcmix-common/receiver.hpp
@@ -4,10 +4,21 @@
#include "protobufclient.hpp"
+/*!
+ * \file
+ */
+
struct SenderReceiver;
+/*!
+ * \brief The Receiver struct is a shim around ProtobufClient and only exposes things needed
+ * for receiving messages.
+ */
struct Receiver : private ProtobufClient<CMixProtoFunctor>
{
+ /*!
+ * \brief friend decleration allowing Receivers to be upgraded to SenderReceivers.
+ */
friend SenderReceiver;
using ProtobufClient::ProtobufClient;