Added documentation for Node class.

This commit is contained in:
Nicolás Ortega Froysa 2017-08-18 18:19:19 -05:00
parent 510fbc0f36
commit 38a67ae0bb
No known key found for this signature in database
GPG Key ID: FEC70E3BAE2E69BF

View File

@ -26,11 +26,28 @@
#endif #endif
namespace neocomm { namespace neocomm {
/**
* @brief Network node.
*/
class Node { class Node {
public: public:
/**
* @brief Initialize local node.
*/
Node(); Node();
virtual ~Node(); virtual ~Node();
/**
* @brief Bind the node to a port.
*
* @param port Local port to bind to.
*/
void bind(const short &port = DEFAULT_PORT); void bind(const short &port = DEFAULT_PORT);
/**
* @brief Retrieve the current status of the connection.
*
* @return String describing connection status.
*/
const std::string getStatus() const; const std::string getStatus() const;
private: private:
dht::DhtRunner node; dht::DhtRunner node;