Plegma API  v2
Yodiwo.API.Plegma.PortEvent Class Reference

Port Event class: used to describe a new event that should trigger an endpoint, either towards a node or the Cloud Services More...

Public Member Functions

 PortEvent ()
 parameterless constructor for Port Events More...
 
 PortEvent (string pkey, string state, uint revNum=0, ulong timestamp=0)
 constructor of PortEvent classes More...
 

Public Attributes

string PortKey
 PortKey of the Port this message refers to (either generating the event, or receiving the event) More...
 
string State
 Contents of the event in string form. See Port.State More...
 
uint RevNum
 Revision number of this update; matches the Port State's internal sequence numbering. See Port.State More...
 
ulong Timestamp
 Timestamp (in msec since Unix Epoch) of event creation More...
 

Detailed Description

Port Event class: used to describe a new event that should trigger an endpoint, either towards a node or the Cloud Services

Constructor & Destructor Documentation

Yodiwo.API.Plegma.PortEvent.PortEvent ( )

parameterless constructor for Port Events

Yodiwo.API.Plegma.PortEvent.PortEvent ( string  pkey,
string  state,
uint  revNum = 0,
ulong  timestamp = 0 
)

constructor of PortEvent classes

Parameters
pkeyPortKey of Port this event refers to
stateState of Port (i.e. contents of message, Port.State
revNumRevision number of this event
timestamptimestamp of this event in msec since Unix Epoch

Member Data Documentation

string Yodiwo.API.Plegma.PortEvent.PortKey

PortKey of the Port this message refers to (either generating the event, or receiving the event)

uint Yodiwo.API.Plegma.PortEvent.RevNum

Revision number of this update; matches the Port State's internal sequence numbering. See Port.State

string Yodiwo.API.Plegma.PortEvent.State

Contents of the event in string form. See Port.State

ulong Yodiwo.API.Plegma.PortEvent.Timestamp

Timestamp (in msec since Unix Epoch) of event creation


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