Plegma API  v2
Yodiwo.API.Plegma.PortEventReq Class Reference

synchronous Port Event request The main API message to exchange events between Nodes and the Yodiwo Cloud Service Similar to PortEventMsg but expects a response linked to this Request via a SyncId More...

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

Public Member Functions

 PortEventReq ()
 parameterless constructor of PortEventReq More...
 
 PortEventReq (int seqNo)
 constructor of PortEventReq with sequence number More...
 
 PortEventReq (int seqNo, PortEvent ev)
 quick(er) constructor for a single-event PortEventReq More...
 
- Public Member Functions inherited from Yodiwo.API.Plegma.PortEventMsg
 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 ()
 

Additional Inherited Members

- Public Attributes inherited from Yodiwo.API.Plegma.PortEventMsg
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

synchronous Port Event request The main API message to exchange events between Nodes and the Yodiwo Cloud Service Similar to PortEventMsg but expects a response linked to this Request via a SyncId

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

Constructor & Destructor Documentation

Yodiwo.API.Plegma.PortEventReq.PortEventReq ( )

parameterless constructor of PortEventReq

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

constructor of PortEventReq with sequence number

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

quick(er) constructor for a single-event PortEventReq

Parameters
seqNosequence number of this message
ev

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