aboutsummaryrefslogtreecommitdiff
path: root/libcmix-network/client.hpp
diff options
context:
space:
mode:
authorDennis Brentjes <d.brentjes@gmail.com>2016-10-16 21:39:18 +0200
committerDennis Brentjes <d.brentjes@gmail.com>2016-10-16 21:39:36 +0200
commitba6da37569dde1ed7616c14d591134575e6a6879 (patch)
tree5562cad589f8c495bd02e61042cf633cd7f0e706 /libcmix-network/client.hpp
parentc9082aa07394e15cd800bd5ad396c37a2334c98d (diff)
downloadcmix-ba6da37569dde1ed7616c14d591134575e6a6879.tar.gz
cmix-ba6da37569dde1ed7616c14d591134575e6a6879.tar.bz2
cmix-ba6da37569dde1ed7616c14d591134575e6a6879.zip
Updates all the documentation.
Mainly covers the network rewrites.
Diffstat (limited to 'libcmix-network/client.hpp')
-rw-r--r--libcmix-network/client.hpp7
1 files changed, 5 insertions, 2 deletions
diff --git a/libcmix-network/client.hpp b/libcmix-network/client.hpp
index 4990667..bd66b98 100644
--- a/libcmix-network/client.hpp
+++ b/libcmix-network/client.hpp
@@ -75,11 +75,10 @@ public:
*/
void async_connect(std::string next_host, std::string next_port, std::function<void()> on_connect);
- inline static void foo() {}
-
/*!
* \brief send sends the string prefixed with it's length over the socket.
* \param message The string to be sent.
+ * \param on_sent The callback to call when the message has been sent.
*/
template <typename F>
void async_send(std::string message, F on_sent) {
@@ -125,6 +124,10 @@ public:
*/
void on_done(OnDoneFT f);
+ /*!
+ * \brief is_open
+ * \return returns true if the underlying socket is opened.
+ */
bool is_open() const;