RestConnect

value RestConnect ( BYREF value rest, string strHostname, value Port = 80, value bUseTLS = FALSE, value bAutoReconnect = FALSE,  value IdleTimeoutInMsec = 30000, string Username = "", string Password = "");

Rückgabewert

Rückgabewert

Beschreibung

TRUE / true / 1

Das REST-Objekt konnte erfolgreich mit dem Server verbunden werden.

FALSE / false / 0

Es konnte keine Verbindung zum Server hergestellt werden. Das REST-Objekt rest kann genutzt werden, um mit RestGetConnectFailReason die Ursache festzustellen.

Parameter

rest

Die Zielvariable für das verbundene REST-Objekt.

strHostname

Die Hostname des REST-Servers.

Port

Der Port des REST-Servers, der für die Verbindung genutzt werden soll.

bUseTLS

Gibt an, ob für die Verbindung das SSL/TLS Protokoll verwendet werden soll.

bAutoReconnect

Gibt an, ob für eine Verbindung automatisch wiederhergestellt werden soll, falls diese getrennt wurde und Rest-Funktionen für dieses REST-Objekt aufgerufen werden, die eine aktive Verbindung zum REST-Server benötigen.

IdleTimeoutInMsec

Die maximale Wartezeit für zusätzlich eingehende Daten während dem Empfang bzw. die maximale Wartezeit für das Senden zusätzlicher Daten.

Username

Wird der Benutzername angegeben, dann wird dieser zur Basic Authentication verwendet. Soll keine Basic Authentication verwendet werden, dann darf auch kein Benutzername angegeben werden.

Password

Gibt das Kennwort an, dass bei der Basic Authentication verwendet werden soll. Soll keine Basic Authentication verwendet werden, dann darf auch kein Kennwort angegeben werden.

Bemerkungen

Baut eine Verbindung zu einem REST-Server auf. Der Hostname strHostname kann ein Domainname oder eine IP-Adresse sein. Es werden sowohl IPv4- als auch IPv6-Adressen unterstützt. Der Port ist normalerweise 80 oder 443. Wenn SSL/TLS erforderlich ist, muss bUseTLS auf TRUE gesetzt werden. Die Option bAutoReconnect gibt an, ob die Verbindung für nachfolgende REST-Anforderungen automatisch wiederhergestellt werden soll. Die Timeout-Zeit IdleTimeoutInMsec gibt die max. Wartezeit an, die während und nach dem Verbindungsaufbau gültig ist - sie kann nach erfolgreichem Verbindungsauf jederzeit mit RestSetIdleTimeout neu gesetzt werden. Soll die Verbindung zum REST-Server getrennt werden, muss das REST-Objekt rest mit RestDisconnect getrennt und geschlossen werden.

Diese Funktion ist für einfache Verbindungen vorgesehen, für die keine Proxys (HTTP oder SOCKS) bzw. SSH-Tunnel erforderlich sind.
Beim Beenden eines laufenden Projekts schließt Victory automatisch alle nicht geschlossenen REST-Objekte.

Beispiel

//ip.jsontest.com liefert als Antwort die IP-Adresse des anfragenden Clients

value rest;
string strLastError, strResponse;
if (!RestConnect(rest, "http://ip.jsontest.com"))
    RestGetLastError(rest, strLastError, true);
    return;
end
RestFullRequest(rest, "GET", "/", NULL, strResponse);

strResponse = JsonExpand(strResponse);
//Inhalt von strResponse:
//{
//  "ip": "82.165.12.98"
//}
RestDisconnect(rest);
 

Die REST-Funktionen

Siehe auch  RestConnectAsync, RestDisconnect, RestFullRequest, RestGetLastError