Add manual page for set low latency funciton
This change adds the manual page for the rmr_set_low_latency()
function.
Issue-ID: RIC-631
Signed-off-by: E. Scott Daniels <daniels@research.att.com>
Change-Id: I3c5bd0a27ef36c351b2003c34d70f4f09aff8974
diff --git a/docs/index.rst b/docs/index.rst
index d0d3aeb..6b58d09 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -58,6 +58,7 @@
rmr_rts_msg.3.rst
rmr_send_msg.3.rst
rmr_set_fack.3.rst
+ rmr_set_low_lat.3.rst
rmr_set_stimeout.3.rst
rmr_set_trace.3.rst
rmr_set_vlevel.3.rst
diff --git a/docs/rel-notes.rst b/docs/rel-notes.rst
index a8d76f9..f73f2da 100644
--- a/docs/rel-notes.rst
+++ b/docs/rel-notes.rst
@@ -22,6 +22,13 @@
version 4.0.0, the RMR versions should no longer skip.
+2020 September 15; Version 4.2.4
+--------------------------------
+
+Add man page for the rmr_set_low_latency() function (RIC-631)
+
+
+
2020 September 15; Version 4.2.3
--------------------------------
diff --git a/docs/rmr_set_low_lat.3.rst b/docs/rmr_set_low_lat.3.rst
new file mode 100644
index 0000000..c108f4d
--- /dev/null
+++ b/docs/rmr_set_low_lat.3.rst
@@ -0,0 +1,76 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. CAUTION: this document is generated from source in doc/src/rtd.
+.. To make changes edit the source and recompile the document.
+.. Do NOT make changes directly to .rst or .md files.
+
+============================================================================================
+Man Page: rmr_set_low_lat
+============================================================================================
+
+
+
+
+RMR LIBRARY FUNCTIONS
+=====================
+
+
+
+NAME
+----
+
+rmr_set_low_latency
+
+
+SYNOPSIS
+--------
+
+
+::
+
+ #include <rmr/rmr.h>
+
+ void rmr_set_low_latency( void* vctx );
+
+
+
+
+DESCRIPTION
+-----------
+
+The ``rmr_set_low_latency`` function enables *TCP NO_DELAY*
+if the underlying transport library supports it. This might
+be useful for applications which must send messages at a
+maximum rate.
+
+A call to this function will cause all subsequent connections
+made by the application to set the no delay (low latency)
+option. When no delay is needed, it is recommended that this
+function be called immediately upon a successful call to the
+RMR initialisation function.
+
+The effect of setting "low latency" mode is to disable
+Nagel's algorithm and to send a packet on a connection as
+soon as it is given to the TCP transport. When this option is
+not enabled, TCP may employ Nagel's algorithm and hold the
+packet with the assumption that it can be combined with
+another and sent in the same datagram in an effort to improve
+bandwidth but at the expense of added latency.
+
+
+RETURN VALUE
+------------
+
+There is no return value.
+
+
+ERRORS
+------
+
+This function does not generate any errors.
+
+
+SEE ALSO
+--------
+
+rmr_init(3), rmr_fast_ack(3)