From 28b9e376cfd2d970367fc136af355229943c44a7 Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Fri, 8 Jul 2022 23:25:06 +0200 Subject: [PATCH] Improve documentation for HTTPRequest's `timeout` property --- doc/classes/HTTPRequest.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/classes/HTTPRequest.xml b/doc/classes/HTTPRequest.xml index eec21a65f3e..f095b7a4a41 100644 --- a/doc/classes/HTTPRequest.xml +++ b/doc/classes/HTTPRequest.xml @@ -156,7 +156,7 @@ Maximum number of allowed redirects. This is used to prevent endless redirect loops. - If set to a value greater than [code]0.0[/code], 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 greater than [code]0.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. + 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. If [code]true[/code], multithreading is used to improve performance.