From ad3d46b0b6ca285bbaf1540e9805714addfeb9af Mon Sep 17 00:00:00 2001 From: Dennis Brentjes Date: Sat, 1 Oct 2016 12:08:43 +0200 Subject: Adds some missing documentation of the Client class. --- libcmix-network/client.hpp | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'libcmix-network') diff --git a/libcmix-network/client.hpp b/libcmix-network/client.hpp index cb81418..e1c2e14 100644 --- a/libcmix-network/client.hpp +++ b/libcmix-network/client.hpp @@ -50,8 +50,18 @@ public: */ Client(boost::asio::ip::tcp::socket&& socket); + /*! + * \brief async_connect Asynchronously connects to next_host:port and calls on_connect + * \param next_host The host to connect to + * \param next_port The port to connect to + * \param on_connect The callback to call on a succes. + */ void async_connect(std::string next_host, std::string next_port, std::function on_connect); + /*! + * \brief send sends the string prefixed with it's length over the socket. + * \param message The string to be sent. + */ void send(std::string message); /*! @@ -60,6 +70,9 @@ public: */ void receive(MessageHandler message_handler); + /*! + * \brief close Closes the underlying socket. + */ void close(); /*! -- cgit v1.2.3-70-g09d2