diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2021-04-07 11:54:59 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-04-07 11:54:59 +0200 |
| commit | 1075943cc54266eefd85b1829c282e09d19ef491 (patch) | |
| tree | 5d249555c3d46f1bba3c0ca43c85350cfb3fe918 | |
| parent | e261c2dd9d60a4aae473870b4f93babd8f117072 (diff) | |
| parent | dbff9570285f46b69429fdef79f9272fbc77ca19 (diff) | |
Merge pull request #43900 from nathanfranke/fix-stream-peer-tcp-ambiguity
Improve Ambiguous StreamPeerTCP `set_no_delay` Documentation
| -rw-r--r-- | doc/classes/StreamPeerTCP.xml | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/classes/StreamPeerTCP.xml b/doc/classes/StreamPeerTCP.xml index bb85d94bf9..b6d91715ee 100644 --- a/doc/classes/StreamPeerTCP.xml +++ b/doc/classes/StreamPeerTCP.xml @@ -61,8 +61,8 @@ <argument index="0" name="enabled" type="bool"> </argument> <description> - Disables Nagle's algorithm to improve latency for small packets. - [b]Note:[/b] For applications that send large packets or need to transfer a lot of data, this can decrease the total available bandwidth. + If [code]enabled[/code] is [code]true[/code], packets will be sent immediately. If [code]enabled[/code] is [code]false[/code] (the default), packet transfers will be delayed and combined using [url=https://en.wikipedia.org/wiki/Nagle%27s_algorithm]Nagle's algorithm[/url]. + [b]Note:[/b] It's recommended to leave this disabled for applications that send large packets or need to transfer a lot of data, as enabling this can decrease the total available bandwidth. </description> </method> </methods> |