Update description of tcp-no-delay

barchetta · Dec 12, 2023 · bc510a5 · bc510a5
1 parent 08ff49f
commit bc510a5
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 4 deletions.
diff --git a/docs/config/io_helidon_webserver_ConnectionConfig.adoc b/docs/config/io_helidon_webserver_ConnectionConfig.adoc
@@ -70,7 +70,9 @@ Type: link:{javadoc-base-url}/io.helidon.webserver/io/helidon/webserver/Connecti
 
  @return buffer size, in bytes
  @see java.net.StandardSocketOptions#SO_SNDBUF
-|`tcp-no-delay` |boolean |`false` |This option may improve performance on some systems.
+|`tcp-no-delay` |boolean |`false` |Disable Nagle's algorithm by setting
+ TCP_NODELAY to true. This can result in better performance on Mac or newer linux kernels for some
+ payload types.
  Default is `false`.
 
  @return whether to use TCP_NODELAY, defaults to `false`

diff --git a/docs/includes/guides/performance-tuning.adoc b/docs/includes/guides/performance-tuning.adoc
@@ -60,8 +60,8 @@ server:
     read-timeout: PT0S     
     connect-timeout: PT0S
     
-    # Default (false) is best for most cases. But can make big differences depending
-    # on workload and OS.
+    # Default (false: Nagle's algorithm enabled) is best for most cases. But for some OS and
+    # workloads enabling TCP_NODELAY (disable Nagle's algorithm) can improve performance.
     tcp-no-delay: true|false
 
     # The default is TCP autotuning which is best for most cases.

diff --git a/webserver/webserver/src/main/java/io/helidon/webserver/ConnectionConfigBlueprint.java b/webserver/webserver/src/main/java/io/helidon/webserver/ConnectionConfigBlueprint.java
@@ -107,7 +107,9 @@ interface ConnectionConfigBlueprint {
     boolean reuseAddress();
 
     /**
-     * This option may improve performance on some systems.
+     * Disable <a href="https://en.wikipedia.org/wiki/Nagle%27s_algorithm">Nagle's algorithm</a> by setting
+     * TCP_NODELAY to true. This can result in better performance on Mac or newer linux kernels for some
+     * payload types.
      * Default is {@code false}.
      *
      * @return whether to use TCP_NODELAY, defaults to {@code false}