GAMBAS-BUCH 3.19.5

Diese Klasse stellt einen HTTP-Client zur Verfügung, der Anfragen an einen HTTP-Server sendet und dessen Antwort empfängt.

So erzeugen Sie einen neuen HTTP-Client:

Dim hHTTPClient As HTTPClient
hHTTPClient = New HTTPClient() As "hHTTPClient"  ' → Ereignisname (optional)

Die Klasse HTTPClient verfügt über diese Eigenschaften:

Tabelle 24.2.4.0.1 : Eigenschaften der Klasse HTTPClient

Die Klasse HTTPClient verfügt über die statische Methode DownLoad(…):

Static Function Download ( URL As String [ , Headers As String[] ] ) As String

- URL ist die Adresse
- Headers ist ein optionales String-Array der verwendeten Header

Die Klasse HTTPClient besitzt diese ausgewählten Methoden:

Tabelle 24.2.4.0.2 : Methoden der Klasse HTTPClient

Hinweise

• Post ( ContentType As String, Data As String [ , Headers As String[], TargetFile As String ] ):
• ContentType ist der MIME-Typ der Daten. Data sind die zu setzenden Daten. Headers ist ein optionales String-Array von HTTP-Headern. TargetFile ist eine optionale Datei, in die die Antwort geschrieben wird. Wenn TargetFile nicht angegeben wird, werden die vom Server empfangenen Daten im Speicher abgelegt. Sie können auf die Daten mit den Standard-Stream-Methoden oder der Peek-Methode auf das Dokument zugreifen. Wenn TargetFile angegeben wird, werden die vom Server empfangenen Daten in der angegebenen Datei gespeichert und sind im internen Speicherpuffer nicht verfügbar. Wenn Sie Formulardaten übermitteln möchten, verwenden Sie 'application/x-www-form-urlencoded' als ContentType-Header der Anforderung. Anschließend formatieren Sie den Parameter 'Data' mit einer Zeichenfolge nach der folgenden Syntax: Key1=Wert1&Schlüssel2=Wert2&… .
• Get ( [ Headers As String[], TargetFile As String ] ):
• Header ist ein optionales String-Array von HTTP-Headern, die mit der Anfrage an den Server gesendet werden. TargetFile ist eine optionale Datei, in die die Antwort geschrieben wird. Wenn TargetFile nicht angegeben ist, werden die vom Server empfangenen Daten im Speicher abgelegt. Sie können auf die Daten mit Standard-Stream-Methoden oder der Peek-Methode zugreifen. Wenn TargetFile angegeben wird, werden die vom Server empfangenen Daten in der angegebenen Datei gespeichert und sind danach im internen Speicherpuffer nicht mehr verfügbar.
• Put ( ContentType As String, Data As String [ , Headers As String[ ], TargetFile As String ] ):
• ContentType ist der MIME-Typ der Daten. Data sind die zu setzenden Daten. Headers ist ein optionales String-Array von HTTP-Headern. TargetFile ist der Pfad einer optionalen Datei, in die die Antwort geschrieben wird.
• PostFile ( ContentType As String, Path As String [ , Headers As String[ ], TargetFile As String ] ):
• ContentType ist der MIME-Typ der Datei. Path ist der Pfad der zu sendenden Datei. Headers ist ein optionales String-Array von HTTP-Headern. TargetFile ist eine optionale Datei, in die die Antwort geschrieben wird. Wenn TargetFile nicht angegeben ist, werden die vom Server empfangenen Daten im Speicher abgelegt. Sie können mit Standard-Stream-Methoden oder der Peek-Methode auf das Dokument zugreifen. Wenn TargetFile jedoch angegeben wird, werden die vom Server empfangenen Daten in der angegebenen Datei gespeichert und sind im internen Speicherpuffer danach nicht mehr verfügbar.

Die Klasse HTTPClient verfügt über diese Ereignisse:

Tabelle 24.2.4.0.3 : Ereignisse der Klasse HTTPClient

Im Beispiel wird die Get()-Methode ohne Parameter genutzt. Deshalb werden die vom HTTP-Server empfangenen Daten im Speicher abgelegt. Auf diese Daten wird mit Standard-Stream-Methoden zugegriffen. Die Daten der Website sind überschaubar klein und werden in einer Textbox angezeigt:

Abbildung 24.2.4.0.1: Ausgabe der externen IP-Adresse

Das ist der komplette Quelltext:

[1] ' Gambas class file
[2]
[3] Public Sub Form_Open()
[4]
[5]     MAdditional.CheckNetwork()
[6]     FMain.Caption = ("Current external IP address")
[7]
[8] '-- Note the text on this web page: https://ipecho.net/developers.html
[9]     lblIPAdress.Text = HTTPGetIP("https://ipecho.net/plain")
[10]
[11] End
[12]
[13] Public Function HTTPGetIP(argURL As String) As String
[14]
[15]     Dim hHTTPClient As HttpClient
[16]     Dim sResult As String
[17]
[18]     hHTTPClient = New HttpClient
[19]     hHTTPClient.URL = argURL
[20]     hHTTPClient.Async = False
[21]     hHTTPClient.TimeOut = 10
[22]
[23]     hHTTPClient.Get()
[24]
[25]     If Lof(hHTTPClient) Then sResult = Read #hHTTPClient, Lof(hHTTPClient)
[26]
[27]     Return sResult
[28]
[29] End

Kommentar:

• In der Zeile 5 wird mit der Prozedur CheckNetwork getestet, ob ein Netz erreichbar ist.
• Die externe IP-Adresse wird in der Zeile 9 als Wert der Funktion HTTPGetIP(…) angezeigt.
• Zuerst wird in der Zeile 18 in der Funktion HTTPGetIP(…) ein neuer HTTPClient erzeugt.
• Dem Client werden dann wesentliche Eigenschaften zugewiesen. Die URL der aufzurufenden Seite wird als Argument der o.a. Funktion in der Zeile 19 übergeben.
• Danach wird die Eigenschaft Async auf False gesetzt, was das Setzen eines Timeout nach sich zieht → Eigenschaft TimeOut in der Tabelle 24.2.4.0.1.
• Anschließend werden die Daten in der Zeile 23 mit der Get()-Methode abgerufen und im Speicher abgelegt.
• In der Zeile 25 wird abschließend der Speicher komplett ausgelesen und im Funktionswert von der Funktion HTTPGetIP(…) gespeichert, der in der Zeile 27 ausgegeben wird.

Das Projekt nutzt das Modul MAdditional, das u.a. diese Prozedur enthält:

Public Sub CheckNetwork()
 
    Dim sResponse, sCommand As String
    Dim sIPAddress As String
 
'-- With Desktop.NetworkAvailable (gb.desktop) you can determine whether a network connection exists.
    If Not Desktop.NetworkAvailable Then
       Message.Error(("No network available!<hr>The application will be terminated."))
       Quit
    Endif
 
'-- Check connection to local router by trying to obtain the IP address of the gateway
    sCommand = "route -n | grep ^0.0.0.0 | awk '{print $2}'"
    Shell sCommand To sIPAddress
    If Not sIPAddress Then
       Message.Error(("No connection to lokal router!<hr>The application will be terminated."))
       Quit
    Endif
 
    sCommand = "ping -c 1 8.8.8.8"
    Shell sCommand To sResponse
    If Not InStr(sResponse, "8.8.8.8 ping") Then
       Message.Error(("No connection to the Internet!<hr>The application will be terminated."))
       Quit
    Endif
 
End