diff options
Diffstat (limited to 'node/node.hpp')
| -rw-r--r-- | node/node.hpp | 28 |
1 files changed, 22 insertions, 6 deletions
diff --git a/node/node.hpp b/node/node.hpp index 5668dec..ef9e43c 100644 --- a/node/node.hpp +++ b/node/node.hpp @@ -13,12 +13,22 @@ #include <list> +/*! + * \file + */ + +/*! + * \brief The NodeNetworkSettings struct + */ struct NodeNetworkSettings { - bool is_first; - std::string next_host; - std::string next_port; + bool is_first; ///< Are we the first node in the network. + std::string next_host; ///< Next nodes host. + std::string next_port; ///< Next nodes port. }; +/*! + * \brief The Node class + */ class Node { boost::asio::io_service io_service; @@ -39,11 +49,17 @@ class Node void start_initialisation(); public: + /*! + * \brief Node + * \param listen_settings The listen settings for the accepter. + * \param network_settings The network settings containing if we are first and who is the next node. + */ Node(ListenSettings const& listen_settings, NodeNetworkSettings network_settings); ~Node(); - void run() { - io_service.run(); - } + /*! + * \brief run Starts the underlying io_service + */ + void run(); }; |