godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2025-12-31 17:49:03 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
3.1
godot-docs/classes/class_httprequest.rst
Rémi Verschelde 3e8e67ac95 Sync classref with current source
2020-01-21 09:28:25 +01:00

225 lines
11 KiB
ReStructuredText
Raw Permalink Blame History

:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the HTTPRequest.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_HTTPRequest:
HTTPRequest
===========
**Inherits:** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------
A node with the ability to send HTTP requests.
Properties
----------
+-----------------------------+--------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`body_size_limit<class_HTTPRequest_property_body_size_limit>` |
+-----------------------------+--------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`download_file<class_HTTPRequest_property_download_file>` |
+-----------------------------+--------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`max_redirects<class_HTTPRequest_property_max_redirects>` |
+-----------------------------+--------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`use_threads<class_HTTPRequest_property_use_threads>` |
+-----------------------------+--------------------------------------------------------------------+
Methods
-------
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`cancel_request<class_HTTPRequest_method_cancel_request>` **(** **)** |
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_body_size<class_HTTPRequest_method_get_body_size>` **(** **)** const |
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_downloaded_bytes<class_HTTPRequest_method_get_downloaded_bytes>` **(** **)** const |
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Status<enum_HTTPClient_Status>` | :ref:`get_http_client_status<class_HTTPRequest_method_get_http_client_status>` **(** **)** const |
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`request<class_HTTPRequest_method_request>` **(** :ref:`String<class_String>` url, :ref:`PoolStringArray<class_PoolStringArray>` custom_headers=PoolStringArray( ), :ref:`bool<class_bool>` ssl_validate_domain=true, :ref:`Method<enum_HTTPClient_Method>` method=0, :ref:`String<class_String>` request_data="" **)** |
+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
.. _class_HTTPRequest_signal_request_completed:
- **request_completed** **(** :ref:`int<class_int>` result, :ref:`int<class_int>` response_code, :ref:`PoolStringArray<class_PoolStringArray>` headers, :ref:`PoolByteArray<class_PoolByteArray>` body **)**
This signal is emitted upon request completion.
Enumerations
------------
.. _enum_HTTPRequest_Result:
.. _class_HTTPRequest_constant_RESULT_SUCCESS:
.. _class_HTTPRequest_constant_RESULT_CHUNKED_BODY_SIZE_MISMATCH:
.. _class_HTTPRequest_constant_RESULT_CANT_CONNECT:
.. _class_HTTPRequest_constant_RESULT_CANT_RESOLVE:
.. _class_HTTPRequest_constant_RESULT_CONNECTION_ERROR:
.. _class_HTTPRequest_constant_RESULT_SSL_HANDSHAKE_ERROR:
.. _class_HTTPRequest_constant_RESULT_NO_RESPONSE:
.. _class_HTTPRequest_constant_RESULT_BODY_SIZE_LIMIT_EXCEEDED:
.. _class_HTTPRequest_constant_RESULT_REQUEST_FAILED:
.. _class_HTTPRequest_constant_RESULT_DOWNLOAD_FILE_CANT_OPEN:
.. _class_HTTPRequest_constant_RESULT_DOWNLOAD_FILE_WRITE_ERROR:
.. _class_HTTPRequest_constant_RESULT_REDIRECT_LIMIT_REACHED:
enum **Result**:
- **RESULT_SUCCESS** = **0** --- Request successful.
- **RESULT_CHUNKED_BODY_SIZE_MISMATCH** = **1**
- **RESULT_CANT_CONNECT** = **2** --- Request failed while connecting.
- **RESULT_CANT_RESOLVE** = **3** --- Request failed while resolving.
- **RESULT_CONNECTION_ERROR** = **4** --- Request failed due to connection (read/write) error.
- **RESULT_SSL_HANDSHAKE_ERROR** = **5** --- Request failed on SSL handshake.
- **RESULT_NO_RESPONSE** = **6** --- Request does not have a response (yet).
- **RESULT_BODY_SIZE_LIMIT_EXCEEDED** = **7** --- Request exceeded its maximum size limit, see :ref:`body_size_limit<class_HTTPRequest_property_body_size_limit>`.
- **RESULT_REQUEST_FAILED** = **8** --- Request failed. (Unused)
- **RESULT_DOWNLOAD_FILE_CANT_OPEN** = **9** --- HTTPRequest couldn't open the download file.
- **RESULT_DOWNLOAD_FILE_WRITE_ERROR** = **10** --- HTTPRequest couldn't write to the download file.
- **RESULT_REDIRECT_LIMIT_REACHED** = **11** --- Request reached its maximum redirect limit, see :ref:`max_redirects<class_HTTPRequest_property_max_redirects>`.
Description
-----------
A node with the ability to send HTTP requests. Uses :ref:`HTTPClient<class_HTTPClient>` internally.
Can be used to make HTTP requests, i.e. download or upload files or web content via HTTP.
Tutorials
---------
- :doc:`../tutorials/networking/ssl_certificates`
Property Descriptions
---------------------
.. _class_HTTPRequest_property_body_size_limit:
- :ref:`int<class_int>` **body_size_limit**
+----------+----------------------------+
| *Setter* | set_body_size_limit(value) |
+----------+----------------------------+
| *Getter* | get_body_size_limit() |
+----------+----------------------------+
Maximum allowed size for response bodies.
----
.. _class_HTTPRequest_property_download_file:
- :ref:`String<class_String>` **download_file**
+----------+--------------------------+
| *Setter* | set_download_file(value) |
+----------+--------------------------+
| *Getter* | get_download_file() |
+----------+--------------------------+
The file to download into. Will output any received file into it.
----
.. _class_HTTPRequest_property_max_redirects:
- :ref:`int<class_int>` **max_redirects**
+----------+--------------------------+
| *Setter* | set_max_redirects(value) |
+----------+--------------------------+
| *Getter* | get_max_redirects() |
+----------+--------------------------+
Maximum number of allowed redirects.
----
.. _class_HTTPRequest_property_use_threads:
- :ref:`bool<class_bool>` **use_threads**
+----------+------------------------+
| *Setter* | set_use_threads(value) |
+----------+------------------------+
| *Getter* | is_using_threads() |
+----------+------------------------+
If ``true``, multithreading is used to improve performance.
Method Descriptions
-------------------
.. _class_HTTPRequest_method_cancel_request:
- void **cancel_request** **(** **)**
Cancels the current request.
----
.. _class_HTTPRequest_method_get_body_size:
- :ref:`int<class_int>` **get_body_size** **(** **)** const
Returns the response body length.
----
.. _class_HTTPRequest_method_get_downloaded_bytes:
- :ref:`int<class_int>` **get_downloaded_bytes** **(** **)** const
Returns the amount of bytes this HTTPRequest downloaded.
----
.. _class_HTTPRequest_method_get_http_client_status:
- :ref:`Status<enum_HTTPClient_Status>` **get_http_client_status** **(** **)** const
Returns the current status of the underlying :ref:`HTTPClient<class_HTTPClient>`. See ``STATUS_*`` enum on :ref:`HTTPClient<class_HTTPClient>`.
----
.. _class_HTTPRequest_method_request:
- :ref:`Error<enum_@GlobalScope_Error>` **request** **(** :ref:`String<class_String>` url, :ref:`PoolStringArray<class_PoolStringArray>` custom_headers=PoolStringArray( ), :ref:`bool<class_bool>` ssl_validate_domain=true, :ref:`Method<enum_HTTPClient_Method>` method=0, :ref:`String<class_String>` request_data="" **)**
Creates request on the underlying :ref:`HTTPClient<class_HTTPClient>`. If there is no configuration errors, it tries to connect using :ref:`HTTPClient.connect_to_host<class_HTTPClient_method_connect_to_host>` and passes parameters onto :ref:`HTTPClient.request<class_HTTPClient_method_request>`.
Returns :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` if request is successfully created. (Does not imply that the server has responded), :ref:`@GlobalScope.ERR_UNCONFIGURED<class_@GlobalScope_constant_ERR_UNCONFIGURED>` if not in the tree, :ref:`@GlobalScope.ERR_BUSY<class_@GlobalScope_constant_ERR_BUSY>` if still processing previous request, :ref:`@GlobalScope.ERR_INVALID_PARAMETER<class_@GlobalScope_constant_ERR_INVALID_PARAMETER>` if given string is not a valid URL format, or :ref:`@GlobalScope.ERR_CANT_CONNECT<class_@GlobalScope_constant_ERR_CANT_CONNECT>` if not using thread and the :ref:`HTTPClient<class_HTTPClient>` cannot connect to host.
Reference in New Issue View Git Blame Copy Permalink