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 /client/cmixclient.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 'client/cmixclient.hpp')
| -rw-r--r-- | client/cmixclient.hpp | 23 |
1 files changed, 20 insertions, 3 deletions
diff --git a/client/cmixclient.hpp b/client/cmixclient.hpp index 1edb08e..d87c4b3 100644 --- a/client/cmixclient.hpp +++ b/client/cmixclient.hpp @@ -11,11 +11,21 @@ #include <string> #include <vector> +/*! + * \file + */ + +/*! + * \brief The NodeDetails struct + */ struct NodeDetails { - std::string host; - std::string port; + std::string host; ///< The host of the node. + std::string port; ///< The port of the node. }; +/*! + * \brief The CMixClient class + */ class CMixClient { struct NodeData { @@ -39,9 +49,16 @@ class CMixClient { void handle_message(int node_id, cmix_proto::CMixMessage message); -public: +public: + /*! + * \brief CMixClient + * \param details A vector of the connectiondetails for the cmix network + */ CMixClient(std::vector<NodeDetails> details); ~CMixClient(); + /*! + * \brief run Runs the underlying io_service. + */ void run(); };
\ No newline at end of file |