aboutsummaryrefslogtreecommitdiff
path: root/node/nextnode.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 /node/nextnode.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 'node/nextnode.hpp')
-rw-r--r--node/nextnode.hpp26
1 files changed, 26 insertions, 0 deletions
diff --git a/node/nextnode.hpp b/node/nextnode.hpp
index 42206bb..24b93c4 100644
--- a/node/nextnode.hpp
+++ b/node/nextnode.hpp
@@ -4,13 +4,39 @@
#include <boost/asio/ip/tcp.hpp>
+/*!
+ * \file
+ */
+
+/*!
+ * \brief The NextNode class represents the next node in the network, will only be sent to.
+ */
class NextNode : public Client
{
public:
+ /*!
+ * \brief NextNode
+ * \param socket an rvalue reference to the socket it takes ownership and uses to communicate with the next node in the network.
+ */
NextNode(boost::asio::ip::tcp::socket&& socket);
+ /*!
+ * \brief send
+ * \param message is the string that is send to the next node.
+ */
void send(std::string message);
+
+ /*!
+ * \brief connect
+ * \param next_host The host of the next node.
+ * \param next_port The port of the next node.
+ * \param on_connect The callback to call when the connect was succesfull.
+ */
void connect(std::string next_host, std::string next_port, std::function<void()> on_connect);
+
+ /*!
+ * \brief close This function closes the underlying socket connection.
+ */
void close();
};