diff options
| author | Dennis Brentjes <d.brentjes@gmail.com> | 2016-10-01 12:08:43 +0200 |
|---|---|---|
| committer | Dennis Brentjes <d.brentjes@gmail.com> | 2016-10-01 12:08:43 +0200 |
| commit | ad3d46b0b6ca285bbaf1540e9805714addfeb9af (patch) | |
| tree | 185bf54169a519d182c762a4d90068518d8ee929 /libcmix-network | |
| parent | 43c7aff79e4ea4a88313fcc81f3281b304d95f0d (diff) | |
| download | cmix-ad3d46b0b6ca285bbaf1540e9805714addfeb9af.tar.gz cmix-ad3d46b0b6ca285bbaf1540e9805714addfeb9af.tar.bz2 cmix-ad3d46b0b6ca285bbaf1540e9805714addfeb9af.zip | |
Adds some missing documentation of the Client class.
Diffstat (limited to 'libcmix-network')
| -rw-r--r-- | libcmix-network/client.hpp | 13 |
1 files changed, 13 insertions, 0 deletions
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<void()> 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(); /*! |