MQTT

Frends.MQTT.Receive / 1.1.0

Summary

Connects to a broker, subscribes to a topic and gathers messages for a bounded listening period at a chosen quality of service, then disconnects.

Typical use — collecting from IoT and telemetry brokers on a schedule, where the listening window is the run's unit of work

Details

Frends version
5.7 and newer
Agent
Crossplatform
Target framework
net8.0

Input class contains parameters of the broker connection.

Name Type Default Example Description
Host String broker_host

The address of the MQTT broker.

BrokerPort Int32 1883

The port of the MQTT broker.

ReceivingTime Int32 10

Specifies how many seconds the task (client) will live and process messages.

ClientId String 3fa85f64-5717-4562-b3fc-2c963f66afa6

The client (session) identificator. This will allow to collect messages from an existing session

Topic String example topic

The topic the client subscribes to when connecting.

UseTls12 Boolean false

Whether to use TLS authentication.

QoS QoS QoS.AtMostOnce

The Quality of Service (QoS) level for the MQTT session.

Possible values:

  • AtMostOnce: At most once

  • AtLeastOnce: At least once

  • ExactlyOnce: Exactly once

Username String testuser

Username for authentication.

PasswordSecret String Password123

Password for authentication.

AllowInvalidCertificate Boolean true

When true, allows connections even if the server's TLS certificate is invalid (e.g., self-signed, expired, or hostname mismatch). WARNING: This reduces security and should only be used in development/testing environments or when connecting to internal servers with self-signed certificates.

An unhandled error has occurred. Reload 🗙