Work in progress

The content of this page was not yet updated for Godot 4.2 and may be outdated. If you know how to improve this page or you can confirm that it’s up to date, feel free to open a pull request.

HTTP client class

HTTPClient provides low-level access to HTTP communication. For a higher-level interface, you may want to take a look at HTTPRequest first, which has a tutorial available here.

Warning

When exporting to Android, make sure to enable the INTERNET permission in the Android export preset before exporting the project or using one-click deploy. Otherwise, network communication of any kind will be blocked by Android.

Here’s an example of using the HTTPClient class. It’s just a script, so it can be run by executing:

GDScriptC#

  1. c:\godot> godot -s http_test.gd
  1. c:\godot> godot -s HTTPTest.cs

It will connect and fetch a website.

GDScriptC#

  1. extends SceneTree
  3. # HTTPClient demo
  4. # This simple class can do HTTP requests; it will not block, but it needs to be polled.
  6. func _init():
  7.     var err = 0
  8.     var http = HTTPClient.new() # Create the Client.
  10.     err = http.connect_to_host("www.php.net", 80) # Connect to host/port.
  11.     assert(err == OK) # Make sure connection is OK.
  13.     # Wait until resolved and connected.
  14.     while http.get_status() == HTTPClient.STATUS_CONNECTING or http.get_status() == HTTPClient.STATUS_RESOLVING:
  15.         http.poll()
  16.         print("Connecting...")
  17.         if not OS.has_feature("web"):
  18.             OS.delay_msec(500)
  19.         else:
  20.             yield(Engine.get_main_loop(), "idle_frame")
  22.     assert(http.get_status() == HTTPClient.STATUS_CONNECTED) # Check if the connection was made successfully.
  24.     # Some headers
  25.     var headers = [
  26.         "User-Agent: Pirulo/1.0 (Godot)",
  27.         "Accept: */*"
  28.     ]
  30.     err = http.request(HTTPClient.METHOD_GET, "/ChangeLog-5.php", headers) # Request a page from the site (this one was chunked..)
  31.     assert(err == OK) # Make sure all is OK.
  33.     while http.get_status() == HTTPClient.STATUS_REQUESTING:
  34.         # Keep polling for as long as the request is being processed.
  35.         http.poll()
  36.         print("Requesting...")
  37.         if OS.has_feature("web"):
  38.             # Synchronous HTTP requests are not supported on the web,
  39.             # so wait for the next main loop iteration.
  40.             yield(Engine.get_main_loop(), "idle_frame")
  41.         else:
  42.             OS.delay_msec(500)
  44.     assert(http.get_status() == HTTPClient.STATUS_BODY or http.get_status() == HTTPClient.STATUS_CONNECTED) # Make sure request finished well.
  46.     print("response? ", http.has_response()) # Site might not have a response.
  48.     if http.has_response():
  49.         # If there is a response...
  51.         headers = http.get_response_headers_as_dictionary() # Get response headers.
  52.         print("code: ", http.get_response_code()) # Show response code.
  53.         print("**headers:\\n", headers) # Show headers.
  55.         # Getting the HTTP Body
  57.         if http.is_response_chunked():
  58.             # Does it use chunks?
  59.             print("Response is Chunked!")
  60.         else:
  61.             # Or just plain Content-Length
  62.             var bl = http.get_response_body_length()
  63.             print("Response Length: ", bl)
  65.         # This method works for both anyway
  67.         var rb = PackedByteArray() # Array that will hold the data.
  69.         while http.get_status() == HTTPClient.STATUS_BODY:
  70.             # While there is body left to be read
  71.             http.poll()
  72.             # Get a chunk.
  73.             var chunk = http.read_response_body_chunk()
  74.             if chunk.size() == 0:
  75.                 if not OS.has_feature("web"):
  76.                     # Got nothing, wait for buffers to fill a bit.
  77.                     OS.delay_usec(1000)
  78.                 else:
  79.                     yield(Engine.get_main_loop(), "idle_frame")
  80.             else:
  81.                 rb = rb + chunk # Append to read buffer.
  82.         # Done!
  84.         print("bytes got: ", rb.size())
  85.         var text = rb.get_string_from_ascii()
  86.         print("Text: ", text)
  88.     quit()
  1. using Godot;
  3. public partial class HTTPTest : SceneTree
  4. {
  5.     // HTTPClient demo.
  6.     // This simple class can make HTTP requests; it will not block, but it needs to be polled.
  7.     public override async void _Initialize()
  8.     {
  9.         Error err;
  10.         HTTPClient http = new HTTPClient(); // Create the client.
  12.         err = http.ConnectToHost("www.php.net", 80); // Connect to host/port.
  13.         Debug.Assert(err == Error.Ok); // Make sure the connection is OK.
  15.         // Wait until resolved and connected.
  16.         while (http.GetStatus() == HTTPClient.Status.Connecting || http.GetStatus() == HTTPClient.Status.Resolving)
  17.         {
  18.             http.Poll();
  19.             GD.Print("Connecting...");
  20.             OS.DelayMsec(500);
  21.         }
  23.         Debug.Assert(http.GetStatus() == HTTPClient.Status.Connected); // Check if the connection was made successfully.
  25.         // Some headers.
  26.         string[] headers = { "User-Agent: Pirulo/1.0 (Godot)", "Accept: */*" };
  28.         err = http.Request(HTTPClient.Method.Get, "/ChangeLog-5.php", headers); // Request a page from the site.
  29.         Debug.Assert(err == Error.Ok); // Make sure all is OK.
  31.         // Keep polling for as long as the request is being processed.
  32.         while (http.GetStatus() == HTTPClient.Status.Requesting)
  33.         {
  34.             http.Poll();
  35.             GD.Print("Requesting...");
  36.             if (OS.HasFeature("web"))
  37.             {
  38.                 // Synchronous HTTP requests are not supported on the web,
  39.                 // so wait for the next main loop iteration.
  40.                 await ToSignal(Engine.GetMainLoop(), "idle_frame");
  41.             }
  42.             else
  43.             {
  44.                 OS.DelayMsec(500);
  45.             }
  46.         }
  48.         Debug.Assert(http.GetStatus() == HTTPClient.Status.Body || http.GetStatus() == HTTPClient.Status.Connected); // Make sure the request finished well.
  50.         GD.Print("Response? ", http.HasResponse()); // The site might not have a response.
  52.         // If there is a response...
  53.         if (http.HasResponse())
  54.         {
  55.             headers = http.GetResponseHeaders(); // Get response headers.
  56.             GD.Print("Code: ", http.GetResponseCode()); // Show response code.
  57.             GD.Print("Headers:");
  58.             foreach (string header in headers)
  59.             {
  60.                 // Show headers.
  61.                 GD.Print(header);
  62.             }
  64.             if (http.IsResponseChunked())
  65.             {
  66.                 // Does it use chunks?
  67.                 GD.Print("Response is Chunked!");
  68.             }
  69.             else
  70.             {
  71.                 // Or just Content-Length.
  72.                 GD.Print("Response Length: ", http.GetResponseBodyLength());
  73.             }
  75.             // This method works for both anyways.
  76.             List<byte> rb = new List<byte>(); // List that will hold the data.
  78.             // While there is data left to be read...
  79.             while (http.GetStatus() == HTTPClient.Status.Body)
  80.             {
  81.                 http.Poll();
  82.                 byte[] chunk = http.ReadResponseBodyChunk(); // Read a chunk.
  83.                 if (chunk.Length == 0)
  84.                 {
  85.                     // If nothing was read, wait for the buffer to fill.
  86.                     OS.DelayMsec(500);
  87.                 }
  88.                 else
  89.                 {
  90.                     // Append the chunk to the read buffer.
  91.                     rb.AddRange(chunk);
  92.                 }
  93.             }
  95.             // Done!
  96.             GD.Print("Bytes Downloaded: ", rb.Count);
  97.             string text = Encoding.ASCII.GetString(rb.ToArray());
  98.             GD.Print(text);
  99.         }
  100.         Quit();
  101.     }
  102. }

Previous Next

© Copyright 2014-present Juan Linietsky, Ariel Manzur and the Godot community (CC BY 3.0). Revision 53e837c6.

Built with Sphinx using a theme provided by Read the Docs.