FB_IotMqtt5DisconnectProperties

FB_IotMqtt5DisconnectProperties 1:

Der Funktionsbaustein ermöglicht den Empfang von Informationen zur Verbindungstrennung.

Wenn der Client Disconnect Properties empfangen hat und diese am Ausgang bereitstellt, wird dies mittels bPropertiesAvailable=TRUE angezeigt.

Allgemeine Beschreibung der Disconnect Properties:

Eigenschaft

Beschreibung

Reason Code

Gibt den Grund für den Disconnect an, wie in MQTTv5 Spezifikation Kapitel 3.14.2.1 beschrieben. Wird üblicherweise zur programmatischen Auswertung verwendet.

Reason String

Gibt den Grund für den Disconnect in leserlicher Form an. Wird üblicherweise nicht zur programmatischen Auswertung verwendet.

Session Expiry Interval

Gibt das Ablaufinterval für die Session an (in Sekunden).

Server Reference

Kann vom Message Broker in Zusammenhang mit ReasonCode 0x9C (Use Another Server) oder 0x9D (Server moved) verwendet werden, um einen neuen Server anzugeben. Das Format der Server Reference ist hierbei nicht von der Spezifikation vorgeschrieben und somit abhängig vom verwendeten Message Broker.

User Properties

User Properties sind Key/Value Paare, welche an die PublishProperties angehängt werden können. Dies erfolgt mittels des Bausteins FB_IotMqtt5UserProperties. Die Bedeutung der UserProperties ist nicht Bestandteil der MQTT5 Spezifikation und somit applikationsspezifisch.

Syntax

Definition:

FUNCTION_BLOCK FB_IotMqtt5DisconnectProperties EXTENDS FB_IotMqtt5UserProperties
VAR_OUTPUT
    bError           : BOOL;
    hrErrorCode      : HRESULT;
END_VAR

FB_IotMqtt5DisconnectProperties 2: 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.

FB_IotMqtt5DisconnectProperties 3: Eigenschaften

Name

Typ

Zugriff

Beschreibung

bPropertiesAvailable

BOOL

Get

Gibt an, ob Properties vorhanden sind.

nReasonCode

BYTE

Get

Gibt den Disconnect Grund als numerischen Wert an.

nSessionExpire

UDINT

Get

Gibt eine Lebensdauer in Sekunden für die Session an.

sReasonString

STRING

Get

Gibt den Disconnect Grund als leserlichen Wert an.

sServerReference

STRING

Get

Gibt bei ReasonCode 0x9C oder 0x9D eine optionale Server Reference an.

FB_IotMqtt5DisconnectProperties 4: Methoden

Name

Beschreibung

SetDisconnectProperties

Ermöglicht das Setzen der Disconnect Properties.

Voraussetzungen

Entwicklungsumgebung

Zielplattform

Einzubindende SPS-Bibliotheken

TwinCAT v3.1.4026.0

IPC oder CX (x86, x64, ARM)

Tc3_IotBase (>= v3.4.2.0)