SPL File MSGTypes.spl
Content
- Functions
-
- newControlSignal(MQTTSourceUpdate.TopicsUpdateAction, list<rstring>, uint32): Convenience method for creating a control signal that modifies subscription setting for MQTTSource operator
- Types
-
- MQTTBlobMsg: Minimum Input/Output Stream Schema type for MQTT operators
- MQTTRStringMsg: Minimum Input/Output Stream Schema type for MQTT operators
- MQTTSinkUpdate.ControlPortType: The expected schema for the control input port in the MQTTSink operator
- MQTTSourceUpdate.ControlPortType: Expected schema for the control input port of the MQTTSource operator
- MQTTSourceUpdate.TopicsUpdateAction: Actions that can be applied to update the topics / Qos for MQTTSource operator
- MQTTSourceUpdate.TopicsUpdateDesc: A descriptor to describe how the topics / qos should be updated in MQTTSource operator.
Composites
composite MQTTSourceUpdate
Composite that defines types to be used to update MQTTSource operator using control port
Static Types
- MQTTSourceUpdate.ControlPortType = list<TopicsUpdateDesc> topic, map<rstring, rstring> mqttConfig;
-
Expected schema for the control input port of the MQTTSource operator
- MQTTSourceUpdate.TopicsUpdateAction = enum { ADD, REMOVE, REPLACE, UPDATE };
-
Actions that can be applied to update the topics / Qos for MQTTSource operator
- MQTTSourceUpdate.TopicsUpdateDesc = TopicsUpdateAction action, list<rstring> topics, uint32 qos;
-
A descriptor to describe how the topics / qos should be updated in MQTTSource operator. action - the action to apply for the topics specified topics - list of topics to add / remove / update or replace qos - qos of the topics to be added, updated or replace. value is ignored for remove action. Valid value is 0,1 or 2.
composite MQTTSinkUpdate
Composite that contains types to be used to update MQTTSink operator using control port
Static Types
- MQTTSinkUpdate.ControlPortType = map<rstring, rstring> mqttConfig;
-
The expected schema for the control input port in the MQTTSink operator
Functions
MQTTSourceUpdate.ControlPortType newControlSignal(MQTTSourceUpdate.TopicsUpdateAction action, list<rstring> topics, uint32 qos)
Convenience method for creating a control signal that modifies subscription setting for MQTTSource operator
Parameters
- action: the action to apply for the topics specified
- topics: list of topics to add / remove / update or replace
- qos: qos of the topics to be added, updated or replaced
Returns
- a control signal with expected schema value populated for the control port
Types
MQTTBlobMsg
- data - attribute stores actual content of message in blob format for both input and output port
MQTTBlobMsg = blob data;
MQTTRStringMsg
- data - attribute stores actual content of message in rstring format for both input and output port
MQTTRStringMsg = rstring data;