asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve Ambiguous StreamPeerTCP set_no_delay Documentation

Browse source
This commit is contained in:
Nathan Franke 2020-11-26 15:25:02 -06:00
parent 598b52c1ba
commit dbff957028
No known key found for this signature in database
GPG key ID: 92164DCCF3B1F723
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/classes/StreamPeerTCP.xml
View file

@ -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>