mirror of
https://github.com/stan220/godot-docs.git
synced 2026-09-09 10:29:01 +00:00
Divided by Zer0
2875c009fa
Fixes godotengine/godot#46857 Added supported wait periods after poll() for HTML5 This prevents warning about multiple polls in the same frame and prevent hanging the game when fetching the body chunks
109 lines
3.9 KiB
ReStructuredText
109 lines
3.9 KiB
ReStructuredText
.. _doc_http_client_class:
|
|
|
|
HTTP client class
|
|
=================
|
|
|
|
:ref:`HTTPClient <class_HTTPClient>` provides low-level access to HTTP communication.
|
|
For a higher-level interface, you may want to take a look at :ref:`HTTPRequest <class_HTTPRequest>` first,
|
|
which has a tutorial available :ref:`here <doc_http_request_class>`.
|
|
|
|
Here's an example of using the :ref:`HTTPClient <class_HTTPClient>`
|
|
class. It's just a script, so it can be run by executing:
|
|
|
|
.. code-block:: console
|
|
|
|
c:\godot> godot -s http_test.gd
|
|
|
|
It will connect and fetch a website.
|
|
|
|
::
|
|
|
|
extends SceneTree
|
|
|
|
# HTTPClient demo
|
|
# This simple class can do HTTP requests; it will not block, but it needs to be polled.
|
|
|
|
func _init():
|
|
var err = 0
|
|
var http = HTTPClient.new() # Create the Client.
|
|
|
|
err = http.connect_to_host("www.php.net", 80) # Connect to host/port.
|
|
assert(err == OK) # Make sure connection was OK.
|
|
|
|
# Wait until resolved and connected.
|
|
while http.get_status() == HTTPClient.STATUS_CONNECTING or http.get_status() == HTTPClient.STATUS_RESOLVING:
|
|
http.poll()
|
|
print("Connecting...")
|
|
if not OS.has_feature("web"):
|
|
OS.delay_msec(500)
|
|
else:
|
|
yield(Engine.get_main_loop(), "idle_frame")
|
|
|
|
assert(http.get_status() == HTTPClient.STATUS_CONNECTED) # Could not connect
|
|
|
|
# Some headers
|
|
var headers = [
|
|
"User-Agent: Pirulo/1.0 (Godot)",
|
|
"Accept: */*"
|
|
]
|
|
|
|
err = http.request(HTTPClient.METHOD_GET, "/ChangeLog-5.php", headers) # Request a page from the site (this one was chunked..)
|
|
assert(err == OK) # Make sure all is OK.
|
|
|
|
while http.get_status() == HTTPClient.STATUS_REQUESTING:
|
|
# Keep polling for as long as the request is being processed.
|
|
http.poll()
|
|
print("Requesting...")
|
|
if not OS.has_feature("web"):
|
|
OS.delay_msec(500)
|
|
else:
|
|
# Synchronous HTTP requests are not supported on the web,
|
|
# so wait for the next main loop iteration.
|
|
yield(Engine.get_main_loop(), "idle_frame")
|
|
|
|
assert(http.get_status() == HTTPClient.STATUS_BODY or http.get_status() == HTTPClient.STATUS_CONNECTED) # Make sure request finished well.
|
|
|
|
print("response? ", http.has_response()) # Site might not have a response.
|
|
|
|
if http.has_response():
|
|
# If there is a response...
|
|
|
|
headers = http.get_response_headers_as_dictionary() # Get response headers.
|
|
print("code: ", http.get_response_code()) # Show response code.
|
|
print("**headers:\\n", headers) # Show headers.
|
|
|
|
# Getting the HTTP Body
|
|
|
|
if http.is_response_chunked():
|
|
# Does it use chunks?
|
|
print("Response is Chunked!")
|
|
else:
|
|
# Or just plain Content-Length
|
|
var bl = http.get_response_body_length()
|
|
print("Response Length: ", bl)
|
|
|
|
# This method works for both anyway
|
|
|
|
var rb = PoolByteArray() # Array that will hold the data.
|
|
|
|
while http.get_status() == HTTPClient.STATUS_BODY:
|
|
# While there is body left to be read
|
|
http.poll()
|
|
# Get a chunk.
|
|
var chunk = http.read_response_body_chunk()
|
|
if chunk.size() == 0:
|
|
if not OS.has_feature("web"):
|
|
# Got nothing, wait for buffers to fill a bit.
|
|
OS.delay_usec(1000)
|
|
else:
|
|
yield(Engine.get_main_loop(), "idle_frame")
|
|
else:
|
|
rb = rb + chunk # Append to read buffer.
|
|
# Done!
|
|
|
|
print("bytes got: ", rb.size())
|
|
var text = rb.get_string_from_ascii()
|
|
print("Text: ", text)
|
|
|
|
quit()
|