Home
Reference
Find details on the SPL language, toolkits, APIs, commands, and more.
Toolkits
A toolkit is a set of SPL artifacts, which are organized into a package. Toolkits make SPL or native functions and primitive or composite operators reusable across different applications.
Toolkits
Toolkit com.teracloud.streams.mqtt 3.0.0
Namespace com.teracloud.streams.mqtt

Welcome
Learn about the core capabilities of Teracloud® Streams, its architecture, and key concepts.
Installing
Use this information to install, upgrade, and uninstall the Teracloud® Streams product.
Configuring
Create a basic or an enterprise domain which is a single point for configuring and managing common resources, security, and instances.
Administering
Administer the product by using the Teracloud® Streams graphical user interface, APIs, or the streamtool command-line interface.
Developing
Develop stream applications with the Streams Processing Language (SPL), Java, and Python.
Troubleshooting
Resolve problems with Teracloud® Streams using the troubleshooting tools provided with the product as well as the resources offered by Teracloud Support.
Reference
Find details on the SPL language, toolkits, APIs, commands, and more.
- APIs
  Application programming interfaces (APIs) provide functions that simplify applications development.
- Job configuration overlays
  You can specify or change configuration parameters when you use the submitjob or updateoperators operations. The settings control submission constraints, host constraints and locations, and operator status. Parameters are captured and updated in the configuration JSON file. When you change the values in the job configuration overlay file, the changes override any previously set values.
- Commands
  Teracloud® Streams provides a number of commands you use to perform tasks.
- Operator model
  An operator model is an XML document that describes the basic properties of a primitive operator.
- Streams Processing Language (SPL)
  Streams Processing Language (SPL) is a distributed data flow composition language that is used in Teracloud® Streams. SPL has primitive types, program structures, and definitions that are tailored for streaming data.
- Toolkits
  A toolkit is a set of SPL artifacts, which are organized into a package. Toolkits make SPL or native functions and primitive or composite operators reusable across different applications.
  - Specialized toolkit requirements and restrictions
    Several of the specialized toolkits require RPMs that are not required by the Teracloud® Streams product. There are also toolkit restrictions on some platforms.
  - Toolkits
- SPLDOC markup
  You can use SPLDOC markup in the descriptions associated with the SPL artifacts in a toolkit. The spl-make-doc command generates HTML documentation from the marked up artifacts.
Glossary
Use this glossary to find terms and definitions for Teracloud® Streams.

Namespace com.teracloud.streams.mqtt

Operator control input port

Operators

MQTTSink: The MQTTSink operator creates a message for every tuple it receives on its input port and publishes the message to an MQTT server.
MQTTSource: The MQTTSource operator subscribes to MQTT topics and receives messages when they are published to subscribed topics.

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.