aboutsummaryrefslogtreecommitdiff
path: root/libcmix-network/nodeclient.hpp
diff options
context:
space:
mode:
authorDennis Brentjes <d.brentjes@gmail.com>2016-09-28 13:18:18 +0200
committerDennis Brentjes <d.brentjes@gmail.com>2016-09-28 13:18:18 +0200
commit3fe7a5b6a18b6841ae51f294dc58fe9c8df6d375 (patch)
tree345583aaf457ce5076d0d5f7c158628dfd971360 /libcmix-network/nodeclient.hpp
parent85d25eebd38bb278ad598a291a007938854945a4 (diff)
downloadcmix-3fe7a5b6a18b6841ae51f294dc58fe9c8df6d375.tar.gz
cmix-3fe7a5b6a18b6841ae51f294dc58fe9c8df6d375.tar.bz2
cmix-3fe7a5b6a18b6841ae51f294dc58fe9c8df6d375.zip
Finally made a initial doxygen documentation pass over all files.
Diffstat (limited to 'libcmix-network/nodeclient.hpp')
-rw-r--r--libcmix-network/nodeclient.hpp29
1 files changed, 29 insertions, 0 deletions
diff --git a/libcmix-network/nodeclient.hpp b/libcmix-network/nodeclient.hpp
index 9a3799a..ca1ee67 100644
--- a/libcmix-network/nodeclient.hpp
+++ b/libcmix-network/nodeclient.hpp
@@ -6,15 +6,44 @@
#include <vector>
+/*!
+ * \file
+ */
+
+/*!
+ * \brief The NodeClient class
+ */
class NodeClient
{
+ /*!
+ * \brief client
+ */
Client client;
+
+ /*!
+ * \brief handle_message
+ * \param message
+ */
void handle_message(std::vector<uint8_t> message);
public:
+
+ /*!
+ * \brief NodeClient
+ * \param socket
+ */
NodeClient(boost::asio::ip::tcp::socket&& socket);
+
virtual ~NodeClient() = default;
+ /*!
+ * \brief receive
+ */
void receive();
+
+ /*!
+ * \brief on_done
+ * \param done
+ */
void on_done(Client::OnDoneFT done);
};