From 7804df7743512876e4df39bee1b393c649b3aad7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Endre=20S=C3=A1ndor=20Varga?= Date: Fri, 15 Mar 2013 11:08:42 +0100 Subject: [PATCH] Updated documentation --- akka-docs/rst/java/io.rst | 5 +++++ akka-docs/rst/scala/io.rst | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/akka-docs/rst/java/io.rst b/akka-docs/rst/java/io.rst index e6984de46d..ac78ee052e 100644 --- a/akka-docs/rst/java/io.rst +++ b/akka-docs/rst/java/io.rst @@ -127,6 +127,11 @@ When connecting, it is also possible to set various socket options or specify a .. includecode:: code/docs/io/IODocTest.java#connect-with-options +.. note:: + The SO_NODELAY (TCP_NODELAY on Windows) socket option defaults to true in Akka, independently of the OS default + settings. This setting disables Nagle's algorithm considerably improving latency for most applications. This setting + could be overridden by passing ``SO.TcpNoDelay(false)`` in the list of socket options of the ``Connect`` message. + After issuing the ``Connect`` command the TCP manager spawns a worker actor to handle commands related to the connection. This worker actor will reveal itself by replying with a ``Connected`` message to the actor who sent the ``Connect`` command. diff --git a/akka-docs/rst/scala/io.rst b/akka-docs/rst/scala/io.rst index 6d9b5f259a..fa91868e81 100644 --- a/akka-docs/rst/scala/io.rst +++ b/akka-docs/rst/scala/io.rst @@ -176,6 +176,11 @@ When connecting, it is also possible to set various socket options or specify a IO(Tcp) ! Connect(remoteSocketAddress, Some(localSocketAddress), List(SO.KeepAlive(true))) +.. note:: + The SO_NODELAY (TCP_NODELAY on Windows) socket option defaults to true in Akka, independently of the OS default + settings. This setting disables Nagle's algorithm considerably improving latency for most applications. This setting + could be overridden by passing ``SO.TcpNoDelay(false)`` in the list of socket options of the ``Connect`` message. + After issuing the ``Connect`` command the TCP manager spawns a worker actor to handle commands related to the connection. This worker actor will reveal itself by replying with a ``Connected`` message to the actor who sent the ``Connect`` command.