SetProxy

TwinCAT TIA
Netzwerk REST Client ActiveClients Ein Client

ns=2;s=DEPRAG Smart/Network/HTTP/REST/ActiveClients/0/SetProxy

Setzt den Proxy-Server. Der Proxy-Server wird für alle Anfragen an die API verwendet.

Parameter:

    Host
    IP oder DNS-Adresse des Proxy-Servers.
    Port
    Port des Proxy-Servers.
    UseDefaultCredentials
    Gibt an, ob bei der Anmeldung am Proxy-Server die Systemanmeldeinformationen benutzt werden sollen oder Benutzername und Password selbst angegeben werden.
    UserName
    Benutzername mit dem sich beim angegebenen Proxy-Server authentifiziert wird.
    Password
    Passwort mit dem sich beim angegebenen Proxy-Server authentifiziert wird.

Rückgabewert:

    SetProxy
    Eine Variable vom Typ OpcMethodReturnValueVoid. Die Methode hat keine befehlsspezifischen Rückgabewerte.

Beispiele:

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

Beckhoff Parameter:

    bHttpSetProxy
    Eine boolesche Variable, über welche die Ausführung des SetProxy-Befehls getriggert werden kann.
    OutputDataHttpSetProxy
    Eine Instanz der ST_VoidOutputData Struktur, in welche der Rückgabewert der SetProxy-Methode geschrieben wird.
    hrHttpSetProxy
    Hiermit kann die Ausführung des Befehls überwacht werden. Fehler-Codes haben den Typ HRESULT.
    fbHttpRest
    Eine Instanz des, mit der DEPRAG Smart-Bibliothek gelieferten, "FB_HttpRest" Funktionsbausteins.
    sHost
    Eine String(255)-Variable, in welcher die IP oder DNS-Adresse des Proxy-Servers hinterlegt wird.
    nPort
    Eine DINT-Variable, welche den Port des Proxy-Servers enthält.
    bBypassProxyOnLocal
    Eine boolsche Variable, durch welche der Proxy-Server für lokale Adressen umgangen werden kann.
    bUseDefaultCredentials
    Eine boolsche Variable für die Auswahl zwischen den verwenden der Systemanmeldeinformationen und dem eingeben eines Benutzernamens und Passworts.
    sUserName
    Eine String(255)-Variable, durch welche ein Benutzername zum authentifizieren am Proxy-Server hinterlegt werden kann.
    sPassword
    Eine String(255)-Variable, durch welche ein Passwort zum authentifizieren am Proxy-Server hinterlegt werden kann.
    sDomain
    Eine String(255)-Variable für die Proxy-Server Domain.
    sClientId
    Eine String(255)-Variable, welche den Client spezifiziert, der den Befehl ausführen soll.
    ConnectionHandle
    Beim Verbindungsaufbau zwischen DEPRAG Smart Server und Ihrem OPC UA Client erhaltenes "ConnectionHandle".


VAR
 bHttpSetProxy     : BOOL;
 OutputDataHttpSetProxy   : ST_VoidOutputData;
 hrHttpSetProxy    : HRESULT;
 
   fbHttpRest   : FB_HttpRest;
END_VAR

hrHttpSetProxy := fbHttpRest.SetProxy( 
       bExecute    := bHttpSetProxy,
       ConnectionHandle   := depragSmartConnection.ConnectionHandle,
       sHost     := 'TestHost',
       nPort     := 1234,
       bBypassProxyOnLocal  := TRUE,
       bUseDefaultCredentials := TRUE,
       sUserName    := 'User1',
       sPassword    := 'Password123',
       sDomain     := 'http://OpcUa.deprag.com/',
       sClientId    := '0',
       OutputData    => OutputDataHttpSetProxy);
IF hrHttpSetProxy <> S_FALSE THEN
 bHttpSetProxy := 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.