godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #43900 from nathanfranke/fix-stream-peer-tcp-ambiguity

Browse Source 
Improve Ambiguous StreamPeerTCP `set_no_delay` Documentation
This commit is contained in:
Rémi Verschelde 2021-04-07 11:54:59 +02:00 committed by GitHub
commit 1075943cc5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
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>