diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2020-11-07 16:38:28 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-11-07 16:38:28 +0100 |
| commit | 709964849fdc0c2cb34e5e851df71a66ee28ba1e (patch) | |
| tree | 799d8c06cafa52d70dcc376845c796f49e18bfc9 /doc/classes | |
| parent | 329d2c1ced685a107b1c27e67b212b5620968a0a (diff) | |
| parent | 13357095eef1bf644ae3f878143716f73e2afd2a (diff) | |
Merge pull request #42896 from Calinou/httprequest-increase-chunk-size
Increase the default HTTPClient download chunk size to 64 KiB
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/HTTPClient.xml | 2 | ||||
| -rw-r--r-- | doc/classes/HTTPRequest.xml | 4 |
2 files changed, 3 insertions, 3 deletions
diff --git a/doc/classes/HTTPClient.xml b/doc/classes/HTTPClient.xml index c308caab50..ec8ca7456a 100644 --- a/doc/classes/HTTPClient.xml +++ b/doc/classes/HTTPClient.xml @@ -181,7 +181,7 @@ <member name="connection" type="StreamPeer" setter="set_connection" getter="get_connection"> The connection to use for this client. </member> - <member name="read_chunk_size" type="int" setter="set_read_chunk_size" getter="get_read_chunk_size" default="4096"> + <member name="read_chunk_size" type="int" setter="set_read_chunk_size" getter="get_read_chunk_size" default="65536"> The size of the buffer used and maximum bytes to read per iteration. See [method read_response_body_chunk]. </member> </members> diff --git a/doc/classes/HTTPRequest.xml b/doc/classes/HTTPRequest.xml index 6c3d0102b9..6eae881ffe 100644 --- a/doc/classes/HTTPRequest.xml +++ b/doc/classes/HTTPRequest.xml @@ -151,9 +151,9 @@ <member name="body_size_limit" type="int" setter="set_body_size_limit" getter="get_body_size_limit" default="-1"> Maximum allowed size for response bodies. If the response body is compressed, this will be used as the maximum allowed size for the decompressed body. </member> - <member name="download_chunk_size" type="int" setter="set_download_chunk_size" getter="get_download_chunk_size" default="4096"> + <member name="download_chunk_size" type="int" setter="set_download_chunk_size" getter="get_download_chunk_size" default="65536"> The size of the buffer used and maximum bytes to read per iteration. See [member HTTPClient.read_chunk_size]. - Set this to a higher value (e.g. 65536 for 64 KiB) when downloading large files to achieve better speeds at the cost of memory. + Set this to a lower value (e.g. 4096 for 4 KiB) when downloading small files to decrease memory usage at the cost of download speeds. </member> <member name="download_file" type="String" setter="set_download_file" getter="get_download_file" default=""""> The file to download into. Will output any received file into it. |