Unsubscribe
Mit dieser Methode meldet der Client dem Broker, dass keine weiteren Nachrichten mit dem angegebenen Topic mehr zu ihm übertragen werden sollen.
Mögliche Fehler werden an den Ausgängen bError und hrErrorCode der Bausteininstanz ausgegeben.
Syntax
METHOD Unsubscribe : BOOL
VAR_IN_OUT
sTopic : STRING; // topic string (UTF-8) with any length (attend that MQTT topics are case sensitive)
END_VAR
VAR_INPUT
pProps : POINTER TO MqttUnsubscribeProperties; // optional
END_VAR
Rückgabewert
Name | Typ | Beschreibung |
|---|---|---|
Unsubscribe | BOOL | Bei erfolgreichem Aufruf liefert die Methode den Rückgabewert TRUE. |
Eingänge
Name | Typ | Beschreibung |
|---|---|---|
pProps | POINTER TO MqttUnsubscribeProperties | Pointer auf zu verschickende Unsubscribe Properties. Der Parameter ist optional. Um Unsubscribe Properties anzugeben kann der FB_IotMqtt5UnsubscribeProperties zur Hilfe genommen werden. |
Ein-/Ausgänge
Name | Typ | Beschreibung |
|---|---|---|
sTopic | STRING | Topic, mit dem keine weiteren Nachrichten empfangen werden sollen. |