diff options
| author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2022-07-08 23:23:22 +0200 |
|---|---|---|
| committer | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2022-07-08 23:24:45 +0200 |
| commit | 5f0cad8cfac1c0d58b0be0dea79287090835764a (patch) | |
| tree | 489a0477215818526e19cb27cb64ea8b3b40b6ab | |
| parent | d26442e709f6361af9ac755ec9291bb43f2cd69b (diff) | |
Document the `timeout` property in HTTPRequest
| -rw-r--r-- | doc/classes/HTTPRequest.xml | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/doc/classes/HTTPRequest.xml b/doc/classes/HTTPRequest.xml index f138b9087b..3d2e9449e2 100644 --- a/doc/classes/HTTPRequest.xml +++ b/doc/classes/HTTPRequest.xml @@ -251,6 +251,7 @@ Maximum number of allowed redirects. </member> <member name="timeout" type="float" setter="set_timeout" getter="get_timeout" default="0.0"> + If set to a value greater than [code]0.0[/code] before the request starts, the HTTP request will time out after [code]timeout[/code] seconds have passed and the request is not [i]completed[/i] yet. For small HTTP requests such as REST API usage, set [member timeout] to a value between [code]10.0[/code] and [code]30.0[/code] to prevent the application from getting stuck if the request fails to get a response in a timely manner. For file downloads, leave this to [code]0.0[/code] to prevent the download from failing if it takes too much time. </member> <member name="use_threads" type="bool" setter="set_use_threads" getter="is_using_threads" default="false"> If [code]true[/code], multithreading is used to improve performance. |