diff options
| author | Dennis Brentjes <d.brentjes@gmail.com> | 2016-10-16 21:39:18 +0200 |
|---|---|---|
| committer | Dennis Brentjes <d.brentjes@gmail.com> | 2016-10-16 21:39:36 +0200 |
| commit | ba6da37569dde1ed7616c14d591134575e6a6879 (patch) | |
| tree | 5562cad589f8c495bd02e61042cf633cd7f0e706 /libcmix-common/senderreceiver.hpp | |
| parent | c9082aa07394e15cd800bd5ad396c37a2334c98d (diff) | |
| download | cmix-ba6da37569dde1ed7616c14d591134575e6a6879.tar.gz cmix-ba6da37569dde1ed7616c14d591134575e6a6879.tar.bz2 cmix-ba6da37569dde1ed7616c14d591134575e6a6879.zip | |
Updates all the documentation.
Mainly covers the network rewrites.
Diffstat (limited to 'libcmix-common/senderreceiver.hpp')
| -rw-r--r-- | libcmix-common/senderreceiver.hpp | 18 |
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; |