Subscribe
Mit dieser Methode meldet der Client dem Broker, dass er alle MQTT-Nachrichten mit einem bestimmten Topic erhalten möchte. Die Methode kann eine MQTT-Client-Instanz auf mehrere Topics anmelden.
Mögliche Fehler werden an den Ausgängen bError und hrErrorCode der Bausteininstanz ausgegeben.
Syntax
METHOD Subscribe : BOOL
VAR_IN_OUT
sTopic : STRING; // topic string (UTF-8) with any length (attend that MQTT topics are case sensitive)
END_VAR
VAR_INPUT
eQoS : TcIotMqttQos; // quality of service between the publishing client and the broker
pProps : POINTER TO MqttSubscribeProperties; // optional
END_VAR
Rückgabewert
Name | Typ | Beschreibung |
|---|---|---|
Subscribe | BOOL | Bei erfolgreichem Aufruf liefert die Methode den Rückgabewert TRUE. |
Eingänge
Name | Typ | Beschreibung |
|---|---|---|
eQoS | TcIotMqttQos | "Quality of Service" |
pProps | POINTER TO MqttSubscribeProperties | Pointer auf zu verschickende Subscribe Properties. Der Parameter ist optional. Um Subscribe Properties anzugeben kann der FB_IotMqtt5SubscribeProperties zur Hilfe genommen werden. |
Ein-/Ausgänge
Name | Typ | Beschreibung |
|---|---|---|
sTopic | STRING | Topic der MQTT-Nachricht |