swarmio::Node Class Reference

Represents a Node the Endpoint knows about and can send messages to. More...

#include <Node.h>

Inheritance diagram for swarmio::Node:

Public Member Functions
virtual std::string	GetDescription () const =0
	Get a user-readable description of the node. More...
virtual const std::string &	GetDeviceClass () const =0
	Get the class of the underlying device. More...
virtual const std::string &	GetName () const =0
	Returns the (possibly non-unique) name of the node. More...
virtual const std::string &	GetUUID () const =0
	Returns the unique identifier of the node. More...
virtual bool	IsOnline () const =0
	Checks whether the Node is reachable. More...
virtual	~Node ()
	Destroy the Node object. More...

Detailed Description

Represents a Node the Endpoint knows about and can send messages to.

Definition at line 11 of file libswarmio/include/swarmio/Node.h.

Constructor & Destructor Documentation

virtual swarmio::Node::~Node ( )

inlinevirtual

Destroy the Node object.

Definition at line 54 of file libswarmio/include/swarmio/Node.h.

Member Function Documentation

virtual std::string swarmio::Node::GetDescription ( ) const

pure virtual

Get a user-readable description of the node.

Returns

std::string

Implemented in swarmio::transport::zyre::ZyreNode.

virtual const std::string& swarmio::Node::GetDeviceClass ( ) const

pure virtual

Get the class of the underlying device.

Returns

const std::string&

Implemented in swarmio::transport::BasicNode.

virtual const std::string& swarmio::Node::GetName ( ) const

pure virtual

Returns the (possibly non-unique) name of the node.

Returns

const std::string&

Implemented in swarmio::transport::BasicNode.

virtual const std::string& swarmio::Node::GetUUID ( ) const

pure virtual

Returns the unique identifier of the node.

Returns

const std::string&

Implemented in swarmio::transport::BasicNode.

virtual bool swarmio::Node::IsOnline ( ) const

pure virtual

Checks whether the Node is reachable.

Returns

True if the Node is online.

Implemented in swarmio::transport::zyre::ZyreNode.

---

The documentation for this class was generated from the following file:

• libswarmio/include/swarmio/Node.h