ITER_MQTTSubscribe (SPARQL-Generate for all formats 2.1.0 API)

java.lang.Object
- fr.mines_stetienne.ci.sparql_generate.iterator.IteratorStreamFunctionBase
- - fr.mines_stetienne.ci.sparql_generate.mqtt.ITER_MQTTSubscribe

All Implemented Interfaces:

IteratorFunction
```
public class ITER_MQTTSubscribe
extends IteratorStreamFunctionBase
```
Iterator function iter:MQTTSubscribe connects to a MQTT server, subscribes to some topics, and issues bindings for the topic (first variable) and the message (second variable) when they are received.
See Live example
- Param 1: (a String or URL) the MQTT server. Two types of connection are supported tcp:// for a TCP connection and ssl:// for a TCP connection secured by SSL/TLS;
- Param 2 .. n (optional, Strings): topics to subscribe to.
For SSL configuration (programmatic or using JVM arguments), see the constructor of MqttClient.
Additional connection OPTIONS configuration can be programmatically set using the MqttConnectOptions returned by getOptions().

The MQTT message (byte[]) is assumed to be a UTF-8 string. This behaviour may may changed using setParser(java.util.function.Function<byte[], org.apache.jena.sparql.expr.NodeValue>) static method.
Since:

2018-10-02

Author:

Maxime Lefrançois

Field Summary

Fields
Modifier and Type Field Description

static org.eclipse.paho.client.mqttv3.MqttConnectOptions OPTIONS

static Function<byte[],NodeValue> PARSER

static String URI
- Fields inherited from class fr.mines_stetienne.ci.sparql_generate.iterator.IteratorStreamFunctionBase
  arguments

Constructor Summary

Constructors
Constructor Description

ITER_MQTTSubscribe()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`checkBuild(ExprList args)`	Partially checks if the iterator function can be executed with the given arguments.
`void`	`exec(List<NodeValue> args, Consumer<List<List<NodeValue>>> listListNodeValue)`	IteratorFunction call to a list of evaluated argument values.
`static org.eclipse.paho.client.mqttv3.MqttConnectOptions`	`getOptions()`
`static void`	`setParser(Function<byte[],NodeValue> parser)`

Methods inherited from class fr.mines_stetienne.ci.sparql_generate.iterator.IteratorStreamFunctionBase
build, exec, getContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - URI
```
public static final String URI
```
    See Also:
    
    Constant Field Values
  - OPTIONS
```
public static final org.eclipse.paho.client.mqttv3.MqttConnectOptions OPTIONS
```
  - PARSER
```
public static Function<byte[],NodeValue> PARSER
```
- Constructor Detail
  - ITER_MQTTSubscribe
```
public ITER_MQTTSubscribe()
```
- Method Detail
  - setParser
```
public static void setParser(Function<byte[],NodeValue> parser)
```
  - getOptions
```
public static org.eclipse.paho.client.mqttv3.MqttConnectOptions getOptions()
```
  - checkBuild
```
public void checkBuild(ExprList args)
```
    Description copied from class: IteratorStreamFunctionBase
    
    Partially checks if the iterator function can be executed with the given arguments.
    
    Specified by:
    
    checkBuild in class IteratorStreamFunctionBase
    
    Parameters:
    
    args - -
  - exec
```
public void exec(List<NodeValue> args,
                 Consumer<List<List<NodeValue>>> listListNodeValue)
```
    Description copied from class: IteratorStreamFunctionBase
    
    IteratorFunction call to a list of evaluated argument values.
    
    Specified by:
    
    exec in class IteratorStreamFunctionBase
    
    Parameters:
    
    args - -
    
    listListNodeValue - - where to emit collections of nodevalues