MQTT Retained Messages: Funktionsweise, Regeln und Löschen
Eine Retained Message ist eine MQTT-Nachricht mit gesetztem Retain-Flag. Der Broker speichert pro Topic die letzte Retained Message und sendet sie sofort an jeden neuen Subscriber, sodass ein Client den aktuellen Wert erhält, ohne auf die nächste Veröffentlichung zu warten. Eine Nachricht mit leerer Payload und Retain-Flag auf demselben Topic löscht den gespeicherten Wert.
Was eine Retained Message ist
Eine Retained Message ist ein gewöhnliches MQTT-PUBLISH, bei dem das Retain-Flag auf 1 steht. Der Broker stellt sie wie gewohnt an die aktuellen Subscriber zu und speichert sie zusätzlich als letzten bekannten Wert des Topics. Abonniert später ein Client einen passenden Topic-Filter, sendet ihm der Broker die gespeicherte Nachricht direkt nach dem Abonnieren.
Ohne Retain sieht ein neuer Subscriber nichts, bis der Publisher das nächste Mal sendet. Bei Werten, die sich selten ändern, etwa einem Maschinenzustand oder einer Konfiguration, kann das Minuten oder Stunden dauern. Mit Retain zeigt ein Dashboard den aktuellen Zustand sofort an, egal wann es geöffnet wird.
mosquitto_pub -h broker.example.com -t 'plant/line-3/press-07/state' -m 'running' -r
Jeder Client, der später abonniert, erhält sofort running:
mosquitto_sub -h broker.example.com -t 'plant/line-3/+/state' -v
Die Regeln für Retained Messages
Die Standards MQTT 3.1.1 und 5.0 legen wenige, klare Regeln fest.
| Regel | Bedeutung in der Praxis |
|---|---|
| Eine Retained Message pro Topic | Eine neue Retained Message ersetzt die vorherige auf demselben Topic |
| Zustellung beim Abonnieren | Jedes neue passende Abonnement erhält die gespeicherte Nachricht |
| Wildcards erfassen Retained Messages | Ein Abonnement auf plant/# erhält die Retained Message jedes passenden Topics |
| Leere Payload löscht | Ein Retained-PUBLISH mit null Bytes Payload entfernt die gespeicherte Nachricht |
| Unabhängig von Sessions | Retained Messages bleiben auf dem Broker, auch wenn sich der Publisher trennt |
| QoS bleibt erhalten | Die Zustellung erfolgt mit der niedrigeren Stufe aus gespeicherter QoS und Abonnement-QoS |
Eine Retained Message gehört zu einem Topic, nicht zu einem Client. Sie bleibt auf dem Broker, bis jemand sie ersetzt oder löscht, auch wenn sich der ursprüngliche Publisher nie wieder verbindet. In MQTT 5.0 kann sie zusätzlich ablaufen (siehe unten).
Retained Messages mit QoS 0 sind weniger streng geschützt. MQTT 3.1.1 erlaubt dem Broker ausdrücklich, eine gespeicherte Retained Message mit QoS 0 jederzeit zu verwerfen. Verwenden Sie für Zustände, die nicht verloren gehen dürfen, QoS 1.
So löschen Sie eine Retained Message
Um eine Retained Message zu löschen, veröffentlichen Sie auf demselben Topic eine Nachricht mit Retain-Flag und leerer Payload. Der Broker entfernt die gespeicherte Nachricht und legt die leere Nachricht nicht an ihrer Stelle ab.
mosquitto_pub -h broker.example.com -t 'plant/line-3/press-07/state' -r -n
Die Option -n sendet eine Payload mit der Länge null. Achtung: Eine Payload "" oder ein einzelnes Leerzeichen ist nicht leer. Die Nachricht muss wirklich null Bytes enthalten.
Mit Wildcards funktioniert das Löschen nicht, denn auf einen Topic-Filter kann niemand veröffentlichen. Um viele Retained Messages aufzuräumen, abonnieren Sie mit einer Wildcard, ermitteln so die betroffenen Topics und löschen jedes Topic einzeln.
Woran Subscriber eine Retained Message erkennen
Am Retain-Flag des eingehenden PUBLISH erkennt ein Subscriber, ob er einen gespeicherten Wert oder eine Live-Nachricht erhalten hat. Wird eine Nachricht wegen eines neuen Abonnements gesendet, setzt der Broker das Retain-Flag auf 1. Leitet er eine Nachricht im laufenden Betrieb an einen bestehenden Subscriber weiter, setzt MQTT 3.1.1 das Retain-Flag auf 0, auch wenn der Publisher es gesetzt hatte.
So kann eine Anwendung den ersten Wert als „aktueller Zustand beim Start“ behandeln und spätere Werte als Änderungen. Bei mosquitto_sub unterdrückt die Option -R Nachrichten mit gesetztem Retain-Flag, sodass Sie nur den Live-Verkehr sehen.
mosquitto_sub -h broker.example.com -t 'fleet/+/soc' -R -v
Optionen für Retained Messages in MQTT 5.0
MQTT 5.0 ergänzt drei Einstellungen, die den Umgang mit Retained Messages in großen Installationen erleichtern.
Retain As Published
Retain As Published ist eine Abonnement-Option. Ist sie gesetzt, leitet der Broker Nachrichten mit dem Retain-Flag so weiter, wie der Publisher es gesetzt hat, statt es zu löschen. Das ist vor allem für Bridges zwischen Brokern wichtig, die wissen müssen, welche Nachrichten auf der anderen Seite gespeichert werden sollen.
Retain Handling
Retain Handling ist eine Abonnement-Option mit drei Werten:
| Wert | Verhalten |
|---|---|
| 0 | Retained Messages beim Abonnieren senden (Standard, wie in MQTT 3.1.1) |
| 1 | Retained Messages nur senden, wenn das Abonnement noch nicht bestand |
| 2 | Für dieses Abonnement keine Retained Messages senden |
Mit Wert 1 erhält ein Client die Retained Messages nicht erneut, wenn er ein bestehendes Abonnement nur auffrischt.
Message Expiry Interval
Ein Publisher kann ein Message Expiry Interval in Sekunden setzen. Bei einer Retained Message stellt der Broker sie nach Ablauf dieser Zeit nicht mehr zu. So erhalten neue Subscriber keinen längst veralteten Wert, etwa die letzte Position eines Fahrzeugs, das seit einer Woche offline ist.
Über die Eigenschaft Retain Available im CONNACK kann der Broker außerdem mitteilen, dass er Retained Messages gar nicht unterstützt.
Wann sich Retained Messages eignen
Setzen Sie Retained Messages für Zustände ein, nicht für Ereignisse. Eine einfache Prüffrage: Braucht ein neuer Subscriber sofort den letzten Wert? Dann setzen Sie das Retain-Flag.
Gut geeignet sind:
- Maschinen- und Gerätezustände wie
running,stopped,fault - Online-Status, oft kombiniert mit einem Last Will als Retained Message, der
offlinesetzt - Konfigurationen und Sollwerte
- Langsam veränderliche Messwerte, etwa der Ladezustand auf
fleet/ev-0042/soc - Die aktuellen Werte in einem Unified Namespace, in dem jeder Abnehmer den letzten Stand von
enterprise/site-frankfurt/line-3/press-07/temperwartet
Weniger geeignet sind:
- Ereignisse und Alarme, die einmal gesehen werden sollen und nicht jedem neuen Subscriber erneut zugestellt werden dürfen
- Befehle, denn ein gespeicherter Befehl würde von jedem später abonnierenden Client noch einmal ausgeführt
- Daten mit hoher Rate, bei denen niemand den letzten Wert beim Abonnieren braucht
Eine Retained Message ist keine Historie. Der Broker speichert nur den jeweils letzten Wert pro Topic. Wenn Sie frühere Werte brauchen, speichern Sie diese in einem Historian oder einer Datenbank.