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/cmixprotofunctor.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/cmixprotofunctor.hpp')
| -rw-r--r-- | libcmix-common/cmixprotofunctor.hpp | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/libcmix-common/cmixprotofunctor.hpp b/libcmix-common/cmixprotofunctor.hpp index c15f218..c3f6fe9 100644 --- a/libcmix-common/cmixprotofunctor.hpp +++ b/libcmix-common/cmixprotofunctor.hpp @@ -2,17 +2,52 @@ #include "cmix.pb.h" +/*! + * \file + */ + +/*! + * \brief The CMixProtoFunctor struct Is a functor that enables the ProtobufClient to serialize + * all the types you specify below. + */ + struct CMixProtoFunctor { + /*! + * \brief proto_type Typedef that exposes the cmix proto container message. + */ typedef cmix_proto::CMixMessage proto_type; + /*! + * \def MESSAGE_SETTER_DECL(TYPE) + * Generates a message setter declaration for the Protobuf type in TYPE. + */ #define MESSAGE_SETTER_DECL(TYPE) \ proto_type operator()(cmix_proto::TYPE const& v) + /*! + * #MESSAGE_SETTER_DECL(Initialization) + */ MESSAGE_SETTER_DECL(Initialization); + + /*! + * #MESSAGE_SETTER_DECL(ImANode) + */ MESSAGE_SETTER_DECL(ImANode); + + /*! + * #MESSAGE_SETTER_DECL(ImAClient) + */ MESSAGE_SETTER_DECL(ImAClient); + + /*! + * #MESSAGE_SETTER_DECL(Bye) + */ MESSAGE_SETTER_DECL(Bye); + + /*! + * #MESSAGE_SETTER_DECL(KeyExchange) + */ MESSAGE_SETTER_DECL(KeyExchange); #undef MESSAGE_SETTER |