From 9e4895da833b7777e69efc173f5dc777aaea3201 Mon Sep 17 00:00:00 2001
From: Rickard Green <rickard@erlang.org>
Date: Thu, 29 Nov 2012 01:24:43 +0100
Subject: Add support for busy port message queue

---
 lib/kernel/doc/src/inet.xml | 64 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 64 insertions(+)

(limited to 'lib/kernel/doc')

diff --git a/lib/kernel/doc/src/inet.xml b/lib/kernel/doc/src/inet.xml
index bf6c4cfb1a..bfdb163e17 100644
--- a/lib/kernel/doc/src/inet.xml
+++ b/lib/kernel/doc/src/inet.xml
@@ -487,6 +487,36 @@ fe80::204:acff:fe17:bf38
               example <c>Size == 2</c>, the data received will match
               <c>[Byte1,Byte2|Binary]</c>.</p>
           </item>
+          <tag><c>{high_msgq_watermark, Size}</c> (TCP/IP sockets)</tag>
+          <item>
+	    <p>The socket message queue will be set into a busy
+	    state when the amount of data queued on the message
+	    queue reaches this limit. Note that this limit only
+	    concerns data that have not yet reached the ERTS internal
+	    socket implementation. Default value used is 8 kB.</p>
+	    <p>Senders of data to the socket will be suspended if
+	    either the socket message queue is busy, or the socket
+	    itself is busy.</p>
+	    <p>For more information see the <c>low_msgq_watermark</c>,
+	    <c>high_watermark</c>, and <c>low_watermark</c> options.</p>
+	    <p>Note that distribution sockets will disable the use of
+	    <c>high_msgq_watermark</c> and <c>low_msgq_watermark</c>,
+	    and will instead use the
+	    <seealso marker="erts:erlang#system_info_dist_buf_busy_limit">distribution
+	    buffer busy limit</seealso> which is a similar feature.</p>
+          </item>
+          <tag><c>{high_watermark, Size}</c> (TCP/IP sockets)</tag>
+          <item>
+	    <p>The socket will be set into a busy state when the amount
+	    of data queued internally by the ERTS socket implementation
+	    reaches this limit. Default value used is 8 kB.</p>
+	    <p>Senders of data to the socket will be suspended if
+	    either the socket message queue is busy, or the socket
+	    itself is busy.</p>
+	    <p>For more information see the <c>low_watermark</c>,
+	    <c>high_msgq_watermark</c>, and <c>low_msqg_watermark</c>
+	    options.</p>
+          </item>
           <tag><c>{keepalive, Boolean}</c>(TCP/IP sockets)</tag>
           <item>
             <p>Enables/disables periodic transmission on a connected
@@ -495,6 +525,40 @@ fe80::204:acff:fe17:bf38
               considered broken and an error message will be sent to
               the controlling process. Default disabled.</p>
           </item>
+          <tag><c>{low_msgq_watermark, Size}</c> (TCP/IP sockets)</tag>
+          <item>
+	    <p>If the socket message queue is in a busy state, the
+	    socket message queue will be set in a not busy state when
+	    the amount of data queued in the message queue falls
+	    below this limit. Note that this limit only concerns data
+	    that have not yet reached the ERTS internal socket
+	    implementation. Default value used is 4 kB.</p>
+	    <p>Senders that have been suspended due to either a
+	    busy message queue or a busy socket, will be resumed
+	    when neither the socket message queue, nor the socket
+	    are busy.</p>
+	    <p>For more information see the <c>high_msgq_watermark</c>,
+	    <c>high_watermark</c>, and <c>low_watermark</c> options.</p>
+	    <p>Note that distribution sockets will disable the use of
+	    <c>high_msgq_watermark</c> and <c>low_msgq_watermark</c>,
+	    and will instead use the
+	    <seealso marker="erts:erlang#system_info_dist_buf_busy_limit">distribution
+	    buffer busy limit</seealso> which is a similar feature.</p>
+          </item>
+          <tag><c>{low_watermark, Size}</c> (TCP/IP sockets)</tag>
+          <item>
+	    <p>If the socket is in a busy state, the socket will
+	    be set in a not busy state when the amount of data
+	    queued internally by the ERTS socket implementation
+	    falls below this limit. Default value used is 4 kB.</p>
+	    <p>Senders that have been suspended due to either a
+	    busy message queue or a busy socket, will be resumed
+	    when neither the socket message queue, nor the socket
+	    are busy.</p>
+	    <p>For more information see the <c>high_watermark</c>,
+	    <c>high_msgq_watermark</c>, and <c>low_msgq_watermark</c>
+	    options.</p>
+          </item>
           <tag><c>{nodelay, Boolean}</c>(TCP/IP sockets)</tag>
           <item>
             <p>If <c>Boolean == true</c>, the <c>TCP_NODELAY</c> option
-- 
cgit v1.2.3