Plegma API  v2
Yodiwo.API.Plegma.NodeInfoRsp Class Reference

Node Info Response Message that contains general information about a node including supported Node Types and Capabilities More...

Inheritance diagram for Yodiwo.API.Plegma.NodeInfoRsp:
Yodiwo.API.Plegma.PlegmaApiMsg Yodiwo.API.ApiMsg

Public Member Functions

 NodeInfoRsp ()
 Node Info Response constructor More...
 
 NodeInfoRsp (int seqNo)
 Node Info Response constructor More...
 

Public Attributes

string Name
 Friendly name of responding Node More...
 
eNodeType Type
 Type (eNodeType) of responding Node More...
 
eNodeCapa Capabilities
 Capabilities of this node More...
 
ThingType[] ThingTypes
 List of ThingTypes that this Node presents and implements More...
 
int ThingsRevNum
 Revision number of responding Node's Things More...
 
int SupportedApiRev
 Revision number of supported API version More...
 
string[] BlockLibraries
 List of BlockLibraries that this Node supports More...
 
eEndpointRestrictions Restrictions
 Guide Cloud Servers' behaviour for the duration of the connection; applies on a per node/endpoint basis and is allowed to change between connections; can be used by lower-powered nodes to ease connection overhead it is not saved to any database More...
 
int MaxMsgSize
 specify maximum number of message size (bytes) that node can accept; Cloud will (try to) break larger messages into smaller ones Zero or missing means no limit More...
 
Dictionary< string, string > TransientInfo
 Additional transient info that the node chooses to provide at each connection This is shown / used by Workers, but is not saved in any database Allowed to be null / empty More...
 
Dictionary< string, string > AdditionalInfo
 Additional non-transient info that the node chooses to provide This is shown / used by Workers, and it is saved in the User Context database Existing keys will get their values updated. Unknown keys are created. Allowed to be null / empty More...
 
- Public Attributes inherited from Yodiwo.API.ApiMsg
int SeqNo
 Sequence number of this message More...
 

Detailed Description

Node Info Response Message that contains general information about a node including supported Node Types and Capabilities

Direction: bidirectional (Node->Cloud and Cloud->Node)

In response to a NodeInfoReq

Constructor & Destructor Documentation

Yodiwo.API.Plegma.NodeInfoRsp.NodeInfoRsp ( )

Node Info Response constructor

Yodiwo.API.Plegma.NodeInfoRsp.NodeInfoRsp ( int  seqNo)

Node Info Response constructor

Member Data Documentation

Dictionary<string, string> Yodiwo.API.Plegma.NodeInfoRsp.AdditionalInfo

Additional non-transient info that the node chooses to provide This is shown / used by Workers, and it is saved in the User Context database Existing keys will get their values updated. Unknown keys are created. Allowed to be null / empty

string [] Yodiwo.API.Plegma.NodeInfoRsp.BlockLibraries

List of BlockLibraries that this Node supports

eNodeCapa Yodiwo.API.Plegma.NodeInfoRsp.Capabilities

Capabilities of this node

int Yodiwo.API.Plegma.NodeInfoRsp.MaxMsgSize

specify maximum number of message size (bytes) that node can accept; Cloud will (try to) break larger messages into smaller ones Zero or missing means no limit

string Yodiwo.API.Plegma.NodeInfoRsp.Name

Friendly name of responding Node

eEndpointRestrictions Yodiwo.API.Plegma.NodeInfoRsp.Restrictions

Guide Cloud Servers' behaviour for the duration of the connection; applies on a per node/endpoint basis and is allowed to change between connections; can be used by lower-powered nodes to ease connection overhead it is not saved to any database

int Yodiwo.API.Plegma.NodeInfoRsp.SupportedApiRev

Revision number of supported API version

int Yodiwo.API.Plegma.NodeInfoRsp.ThingsRevNum

Revision number of responding Node's Things

ThingType [] Yodiwo.API.Plegma.NodeInfoRsp.ThingTypes

List of ThingTypes that this Node presents and implements

Dictionary<string, string> Yodiwo.API.Plegma.NodeInfoRsp.TransientInfo

Additional transient info that the node chooses to provide at each connection This is shown / used by Workers, but is not saved in any database Allowed to be null / empty

eNodeType Yodiwo.API.Plegma.NodeInfoRsp.Type

Type (eNodeType) of responding Node


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