User`s manual

50
The following section explains the basics of communicating with the gateway when it is
running the SE framework. An API reference for all RPC requests and responses can be
found in “Appendix A” on page 63.
BASICCOMMUNICATIONOVERVIEW
The gateway communicates via XML encoded RPC requests and responses. These
messages are sent within an RCI wrapper that specifies the RPC target. Typically
requests and responses will also be routed through iDigi which specifies a further SCI
wrapper. Each request can specify whether it should block until a response is ready or
asynchronously return the response. By default, the gateway operates in a polled mode
where asynchronous responses are cached locally and must be explicitly requested. The
gateway can also be configured to push asynchronous responses to the iDigi servers as
they are generated.
In order to communicate with the gateway, XML requests must be generated along with
RCI/SCI wrappers to address the correct device. It is outside the scope of this document
to cover methods for generating and parsing XML, sending requests to the gateway, or
communicating with the iDigi server from within a custom application. The “iDigi SE Web
Sample, Communicating with Gateway” on page 24 can be used to communicate with
the gateway through iDigi.
Communication Protocol
C HAPTER 3