Added documentation for Node class.
This commit is contained in:
parent
510fbc0f36
commit
38a67ae0bb
@ -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;
|
||||||
|
Loading…
Reference in New Issue
Block a user