Skip to content

Commit

Permalink
Improve Ambiguous StreamPeerTCP set_no_delay Documentation
Browse files Browse the repository at this point in the history
(cherry picked from commit dbff957)
  • Loading branch information
nathanfranke authored and akien-mga committed Apr 7, 2021
1 parent ed44e28 commit 8dd6fd0
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions doc/classes/StreamPeerTCP.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down

0 comments on commit 8dd6fd0

Please sign in to comment.