✕
✕

RemoveClient

TwinCAT
Netzwerk MQTT Client

ns=2;s=DEPRAG Smart/Network/MQTT/RemoveClient

Der Befehl beendet die Verbindung eines konkreten MQTT Client und entfernt diesen aus der Liste der aktiven Clients.

Parameter:

    Id
    Eindeutiger nullbasierter Index, mit dem der MQTT Client aus dem Array ActiveClients abgerufen werden kann.

Rückgabewert:

    RemoveClient
    Eine Variable vom Typ OpcMethodReturnValueInt32. In der Eigenschaft Result sind die befehlsspezifischen Rückgabewerte enthalten.
      Result
      Eindeutiger nullbasierter Index, mit dem der MQTT Client aus dem Array ActiveClients abgerufen werden kann.

Beispiele:

Neben den bereits erläuterten Parametern sind für die Implementierung in TwinCAT 3 nachfolgende Variablen anzulegen / zu übergeben:

Beckhoff Parameter:

    bHttpRemoveClient
    Eine boolesche Variable, über welche die Ausführung des RemoveClient-Befehls getriggert werden kann.
    OutputDataHttpRemoveClient
    Eine Instanz der ST_Int32OutputData Struktur, in welche der Rückgabewert der RemoveClient-Methode geschrieben wird.
    hrHttpRemoveClient
    Hiermit kann die Ausführung des Befehls überwacht werden. Fehler-Codes haben den Typ HRESULT.
    fbMqtt
    Eine Instanz des, mit der DEPRAG Smart-Bibliothek gelieferten, "FB_Mqtt" Funktionsbausteins.
    nDeviceId
    Eine DINT-Variable, welche den zu entfernenden Client spezifiziert.
    ConnectionHandle
    Beim Verbindungsaufbau zwischen DEPRAG Smart Server und Ihrem OPC UA Client erhaltenes "ConnectionHandle". 


VAR
  bHttpRemoveClient   : BOOL;
  OutputDataHttpRemoveClient : ST_Int32OutputData;
  hrHttpRemoveClient   : HRESULT;

  fbMqtt  : FB_Mqtt;
END_VAR

fbMqtt.RemoveClient(
     bExecute        := bMqttRemoveClient, 
     ConnectionHandle      := depragSmartConnection.ConnectionHandle, 
     nDeviceId        := 0, 
     OutputData        => OutputDataMqttRemoveClient);
IF hrMqttRemoveClient <> S_FALSE THEN 
    bMqttRemoveClient := FALSE;
END_IF

Für Beispiele und Erklärungen bezüglich der Aufrufe von Knoten via Siemens TIA Portal sei an dieser Stelle auf den Unterpunkt "Siemens TIA Portal" in Abschnitt "Erste Schritte" verwiesen.