...
- topic: The topic to send or receive from
- broker: The adress of the broker
- client_id: The name of the client. Important: If you use Odysseus for sending and receiving, there must be different client_ids!
- qos: The quality of service mode (default 2), see below for an explanation. Other values are 0 and 1
- username: When given, the username is used in connection to broker
- password: When given, the password is used in connection to broker
- connection_timeout: default 30
- keep_alive_interval: default 60
- automatic_reconnect: default true
- protocol_version: default 4 = 3.1.1
- use_ssl: default false
- max_in_flight_messages: default 10
Example
| Code Block |
|---|
// Receiving elements
#PARSER PQL
#RUNQUERY
in = RECEIVE({
transport = 'MQTT',
protocol = 'simplecsv',
source = 'mqttsource',
datahandler = 'Tuple',
options = [
['topic','Test'],
['Broker','tcp://localhost:1883'],
['Client_ID','OdysseusReceiver']
],
schema = [['Message', 'String']]
}
)
// Sending elements
#PARSER PQL
#RUNQUERY
ping = TIMER({PERIOD = 1000, SOURCE = 'Timer'})
input = MAP({EXPRESSIONS = ['"Hallo " + toString(counter())']}, ping)
out = SENDER({
transport = 'MQTT',
protocol = 'simplecsv',
sink = 'mqttsink',
WRAPPER = 'GenericPush',
datahandler = 'Tuple',
options = [
['topic','Test'],
['Broker','tcp://localhost:1883'],
['Client_ID','OdysseusSender']
]
}, input
) |
...
| Code Block |
|---|
#PARSER PQL
#ADDQUERY
timer = TIMER({
id = 'timer1',
period = 1000,
starttime = 0 ,
source = 'source'
}
)
filter = SELECT({
predicate = 'time % 2 == 0',
heartbeatrate = 1
},
timer
)
/// Use updateTransportOption as function
/// first parameter is the name of the sink ("mqttsink")+".transport" to state, that an option of the transport handler should be changed
/// second: The option that should be changed ("TOPIC" is the only value, that is changeable)
/// third: A MEP-Expression that is evaluated and interpreted as String as the new value for the topic.
/// Remark: The function is called in the moment the operator processes the input, i.e. the topic is changed in that moment. If there is e.g.
/// a buffer after this operator, then it is not really clear, which elements will be send to which topic, so it is typically the
/// best to put the command operator directly before the sink
command = COMMAND({
COMMANDEXPRESSION = 'updateTransportOption("mqttsink.transport","TOPIC","TEST"+toString(time % 2))'
},
filter
)
out = SENDER({
transport = 'MQTT',
protocol = 'csv',
sink = 'mqttsink',
WRAPPER = 'GenericPush',
datahandler = 'tuple',
options = [
['topic','TEST'],
['Broker','tcp://192.168.2.34:1888'],
['Client_ID','OdysseusSender']
]
}, command
) |
QoS-Mode:
- QoS 0 ("At most once"): Fire-and-forget. Messages are sent once with no acknowledgment or message storage. If the receiver is disconnected, the message is lost.
- QoS 1 ("At least once"): Guaranteed delivery, but duplicates are possible. The message is stored until an acknowledgment is received. Used for critical updates, provided the system can handle duplicate events.
- QoS 2 ("Exactly once"): Slowest but most secure. Uses a four-step handshake to guarantee messages are neither lost nor duplicated.