FB_IotMqtt5UnsubscribeProperties
Der Funktionsbaustein ermöglicht die Definition von verschiedenen Properties, welche beim Abmelden einer Subscription gesetzt werden können. Hiermit können die folgenden Metadaten vom Client an den Message Broker übertragen werden.
Allgemeine Beschreibung der Unsubscribe Properties:
Eigenschaft | Beschreibung |
|---|---|
User Properties | User Properties sind Key/Value-Paare, welche zusätzliche Metadaten transportieren können. Diese werden über den Baustein FB_IotMqtt5UserProperties verwaltet. Die Bedeutung der UserProperties ist nicht Bestandteil der MQTT5 Spezifikation und somit applikationsspezifisch. |
Syntax
Definition:
FUNCTION_BLOCK FB_IotMqtt5UnsubscribeProperties EXTENDS FB_IotMqtt5UserProperties
VAR_OUTPUT
bError : BOOL;
hrErrorCode : HRESULT;
END_VAR
Ausgänge
Name | Typ | Beschreibung |
|---|---|---|
bError | BOOL | Wird TRUE, sobald eine Fehlersituation eintritt. |
hrErrorCode | HRESULT | Liefert bei einem gesetzten bError-Ausgang einen Fehlercode. Eine Erläuterung zu den möglichen Fehlercodes befindet sich im Anhang. |
Eigenschaften
Name | Typ | Zugriff | Beschreibung |
|---|---|---|---|
pUnsubscribeProperties | POINTER TO MqttUnsubscribeProperties | Get | Pointer auf ein Objekt vom Typ MqttUnsubscribeProperties. Beim Aufruf von FB_IotMqtt5Client.Unsubscribe() ist es möglich dies direkt zu übergeben. |
Methoden
Name | Beschreibung |
|---|---|
SetUnsubscribeProperties | Ermöglicht das Setzen der Unsubscribe Properties. |
Voraussetzungen
Entwicklungsumgebung | Zielplattform | Einzubindende SPS-Bibliotheken |
|---|---|---|
TwinCAT v3.1.4026.0 | IPC oder CX (x86, x64, ARM) | Tc3_IotBase (>= v3.4.2.0) |