Skip to main content

Introspection

Each device must declare the set of supported interfaces and their version. Data Orchestrator needs to know which interfaces the device advertises before processing any further data publish. This message in Data Orchestrator jargon is called introspection and it's performed by publishing on the device root topic the list of interfaces that are installed on the device.

Introspection payload is a simple plain text string, and it has the following format (in BNF like syntax):

introspection ::= "" | introspection_list
introspection_list ::= introspection_entry ";" introspection_list | introspection_entry
introspection_entry ::= interface_name ":" interface_major_version ":" interface_minor_version

The following example is a valid introspection payload:

com.example.MyInterface:1:0;org.example.DraftInterface:0:3

An empty string is the valid introspection payload for a device without interfaces.