diff options
Diffstat (limited to 'libcmix-common/sender.hpp')
| -rw-r--r-- | libcmix-common/sender.hpp | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/libcmix-common/sender.hpp b/libcmix-common/sender.hpp index 72f0b3d..ea16a81 100644 --- a/libcmix-common/sender.hpp +++ b/libcmix-common/sender.hpp @@ -4,10 +4,24 @@ #include "protobufclient.hpp" +/*! + * \file + */ + +/*! + * \brief forward declaration for SenderReceiver to allow for the friend declaration. + */ struct SenderReceiver; +/*! + * \brief The Sender struct is a shim around ProtobufClient and only exposes things needed + * for sending messages. + */ struct Sender : private ProtobufClient<CMixProtoFunctor> { + /*! + * The friend declaration that allows for the Sender to be upgraded to a SenderReceiver. + */ friend SenderReceiver; using ProtobufClient::ProtobufClient; |