Plegma API  v2
Yodiwo.API.Plegma.PortEventMsg Class Reference

asynchronous Port Event message The main API message to exchange events between Nodes and the Yodiwo Cloud Service More...

Inheritance diagram for Yodiwo.API.Plegma.PortEventMsg:
Yodiwo.API.Plegma.PlegmaApiMsg Yodiwo.API.ApiMsg Yodiwo.API.Plegma.PortEventReq Yodiwo.API.Plegma.PortEventRsp

Public Member Functions

 PortEventMsg ()
 parameterless constructor of PortEventMsgs More...
 
 PortEventMsg (int seqNo)
 constructor of PortEventMsgs with sequence numbers More...
 
 PortEventMsg (int seqNo, PortEvent ev)
 quick(er) constructor for a single-event PortEventMsg More...
 
override string ToString ()
 

Public Attributes

PortEvent[] PortEvents
 Array of PortEvent messages More...
 
string BlockKey
 (optional) Block that this event refers to More...
 
bool INeedAck
 (optional) Ask for acknowledgement of the packet. The recipient must reply with a GenericRsp carrying this packet's ApiMsg.SeqNo in its GenericRsp.OrigSeqNo field. More...
 
- Public Attributes inherited from Yodiwo.API.ApiMsg
int SeqNo
 Sequence number of this message More...
 

Detailed Description

asynchronous Port Event message The main API message to exchange events between Nodes and the Yodiwo Cloud Service

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

Constructor & Destructor Documentation

Yodiwo.API.Plegma.PortEventMsg.PortEventMsg ( )

parameterless constructor of PortEventMsgs

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

constructor of PortEventMsgs with sequence numbers

Yodiwo.API.Plegma.PortEventMsg.PortEventMsg ( int  seqNo,
PortEvent  ev 
)

quick(er) constructor for a single-event PortEventMsg

Parameters
seqNosequence number of this message
ev

Member Data Documentation

string Yodiwo.API.Plegma.PortEventMsg.BlockKey

(optional) Block that this event refers to

bool Yodiwo.API.Plegma.PortEventMsg.INeedAck

(optional) Ask for acknowledgement of the packet. The recipient must reply with a GenericRsp carrying this packet's ApiMsg.SeqNo in its GenericRsp.OrigSeqNo field.

PortEvent [] Yodiwo.API.Plegma.PortEventMsg.PortEvents

Array of PortEvent messages


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