hwsd  1.1.1
 All Classes Files Functions Variables Enumerations Enumerator Pages
hwsd::NodeInfo Struct Reference

A structure containing node-specific information. More...

#include <nodeInfo.h>

+ Inheritance diagram for hwsd::NodeInfo:
+ Collaboration diagram for hwsd::NodeInfo:

Public Member Functions

HWSD_API NodeInfo ()
 Default constructor describing a local session. More...
 
HWSD_API bool operator== (const NodeInfo &rhs) const
 
HWSD_API bool operator!= (const NodeInfo &rhs) const
 
HWSD_API bool isLocal () const
 

Static Public Member Functions

static HWSD_API bool isLocal (const std::string &name)
 
static std::string getLocalSession ()
 

Public Attributes

lunchbox::uint128_t id
 Random unique ID identifing the origin node. More...
 
std::string nodeName
 System hostname if remote, empty for local. More...
 
std::string session
 The session name: local, default or custom string. More...
 

Detailed Description

A structure containing node-specific information.

Definition at line 31 of file nodeInfo.h.

Constructor & Destructor Documentation

HWSD_API hwsd::NodeInfo::NodeInfo ( )

Default constructor describing a local session.

Version
1.0

Member Function Documentation

static std::string hwsd::NodeInfo::getLocalSession ( )
inlinestatic
Returns
the session name for local resources.
Version
1.1.1

Definition at line 49 of file nodeInfo.h.

HWSD_API bool hwsd::NodeInfo::isLocal ( ) const
Returns
true if this resource was discovered locally.
Version
1.1.1
static HWSD_API bool hwsd::NodeInfo::isLocal ( const std::string &  name)
static
Returns
true if this resource was discovered locally.
Version
1.1.1
HWSD_API bool hwsd::NodeInfo::operator!= ( const NodeInfo rhs) const
Returns
true if both infos are not identical.
Version
1.0
HWSD_API bool hwsd::NodeInfo::operator== ( const NodeInfo rhs) const
Returns
true if both informations are identical.
Version
1.0

Member Data Documentation

lunchbox::uint128_t hwsd::NodeInfo::id

Random unique ID identifing the origin node.

Version
1.0

Definition at line 52 of file nodeInfo.h.

std::string hwsd::NodeInfo::nodeName

System hostname if remote, empty for local.

Version
1.0

Definition at line 55 of file nodeInfo.h.

std::string hwsd::NodeInfo::session

The session name: local, default or custom string.

Version
1.0

Definition at line 58 of file nodeInfo.h.


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