ST_IotMqtt5Will

Mittels folgender Angaben kann eine Nachricht spezifiziert werden, die bei einem irregulärem Verbindungsabbau zwischen Client und Broker als letzte Nachricht vom Broker zu den Subscribern versendet wird, die das entsprechende Topic abonniert haben. Diese Struktur ist eine Erweiterung der bisherigen Struktur ST_IotMqttWill für MQTT V5.

	Keine Instanziierung und Zuweisung dieser Struktur Diese Struktur erlaubt keine Instanziierung und Zuweisung zum FB_IotMqtt5Client bzw. FB_IotMqtt5ClientBase. Stattdessen wird der Eingangsparameter des MQTT v5 Client Funktionsbausteines direkt verwendet.

Syntax

Definition:

TYPE ST_IotMqtt5Will :
STRUCT
    {attribute 'TcEncoding':='UTF-8'}
    sTopic             : STRING(255);
    fbPayload          : FB_IotDataBuffer;
    eQoS               : TcIotMqttQos := TcIotMqttQos.ExactlyOnceDelivery;
    bRetain            : BOOL;
    {attribute 'TcEncoding':='UTF-8'}
    sContentType       : STRING(255);
    {attribute 'TcEncoding':='UTF-8'}
    sResponseTopic     : STRING(255);
    nMsgExpiryInterval : UDINT; 
    nDelay             : UDINT; 
    bPayloadUtf8       : BOOL; 
    fbCorrelationData  : FB_IotDataBuffer; 
    fbUserProperties   : FB_IotMqtt5UserProperties;
END_STRUCT
END_TYPE

Parameter

Name	Typ	Beschreibung
sTopic	STRING(255)	Topic der Nachricht.
fbPayload	FB_IotDataBuffer	Datenpuffer für den Payload der Nachricht.
eQoS	TcIotMqttQos	Die „Quality of Service“ bietet folgende Einstellmöglichkeiten: QoS-Level 0, QoS-Level 1, QoS-Level 2 (Siehe QoS).
bRetain	BOOL	Wenn bRetain TRUE ist, speichert der Broker die Nachricht, um sie später hinzukommenden Subscribern nachträglich zukommen zu lassen.
sContentType	STRING(255)	Beschreibt das Encoding des Payloads. Hier eignen sich für hohe Kompatibilität vor allem MIME-Typen wie bspw. „text/plain“.
sResponseTopic	STRING(255)	An dieser Stelle kann das Antwort-Topic angegeben werden, auf dem eine Rückantwort eines anderen Clients erwartet wird.
nMsgExpiryInterval	UDINT	Zeit in Sekunden, nach der eine Last Will-Nachricht abläuft und bei einem Verbindungsabbruch nicht mehr durch den Broker zugestellt wird.
nDelay	UDINT	Verzögerungsintervall in Sekunden bis die LastWill Nachricht verschickt wird.
bPayloadUtf8	BOOL	Formatindikator für den Nachrichteninhalt.
fbCorrelationData	FB_IotDataBuffer	Datenpuffer für CorrelationData
fbUserProperties	FB_IotMqtt5UserProperties	An dieser Stelle können UserProperties angegeben werden.