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/CHANGES_CORE.txt b/CHANGES_CORE.txt
index c2aa178..881263a 100644 (file)
--- a/CHANGES_CORE.txt
+++ b/CHANGES_CORE.txt
@@ -5,6 +5,9 @@
 # API and build change  and fix summaries. Doc correctsions
 # and/or changes are not mentioned here; see the commit messages.
 
+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
        Correct arg processing bug in rmr_rpobe (RIC-645)
 

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 94834ba..f71f8dc 100644 (file)
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -41,7 +41,7 @@ cmake_minimum_required( VERSION 3.5 )
 
 set( major_version "4" )               # should be automatically populated from git tag later, but until CI process sets a tag we use this
 set( minor_version "2" )
-set( patch_level "3" )
+set( patch_level "4" )
 
 set( install_root "${CMAKE_INSTALL_PREFIX}" )
 set( install_inc "include/rmr" )

diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index d52a877..b0f5239 100644 (file)
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -79,6 +79,7 @@ if( BUILD_DOC )
                rmr_rts_msg.3
                rmr_send_msg.3
                rmr_set_fack.3
+               rmr_set_low_lat.3
                rmr_set_stimeout.3
                rmr_set_trace.3
                rmr_set_vlevel.3

diff --git a/doc/src/man/rmr_set_low_lat.3.xfm b/doc/src/man/rmr_set_low_lat.3.xfm
new file mode 100644 (file)
index 0000000..7ab08c7
--- /dev/null
+++ b/doc/src/man/rmr_set_low_lat.3.xfm
@@ -0,0 +1,75 @@
+.if false
+==================================================================================
+   Copyright (c) 2019-2020 Nokia
+   Copyright (c) 2018-2020 AT&T Intellectual Property.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+==================================================================================
+.fi
+.if false
+    Mnemonic    rmr_set_low_lat.3.xfm
+    Abstract    The manual page for the set low latency (no delay) function.
+    Author      E. Scott Daniels
+    Date        21 September 2020
+.fi
+
+.gv e LIB lib
+.im &{lib}/man/setup.im
+
+&line_len(6i)
+
+&h1(RMR Library Functions)
+&h2(NAME)
+    rmr_set_low_latency
+
+&h2(SYNOPSIS )
+&indent
+&ex_start
+#include <rmr/rmr.h>
+
+void rmr_set_low_latency( void* vctx );
+
+&ex_end
+&uindent
+
+&h2(DESCRIPTION)
+The &cw(rmr_set_low_latency) function enables &ital(TCP NO_DELAY) if
+the underlying transport library supports it.
+This might be useful for applications which must send messages at a maximum
+rate.
+
+&space
+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.
+
+&space
+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.
+
+&h2(RETURN VALUE)
+There is no return value.
+
+
+&h2(ERRORS)
+This function does not generate any errors.
+
+&h2(SEE ALSO )
+.ju off
+rmr_init(3), rmr_fast_ack(3)
+.ju on
+

diff --git a/docs/index.rst b/docs/index.rst
index d0d3aeb..6b58d09 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -58,6 +58,7 @@ for an overview of the library.
    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 (file)
--- a/docs/rel-notes.rst
+++ b/docs/rel-notes.rst
@@ -22,6 +22,13 @@ the need to leap frog versions ceased, and beginning with
 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 (file)
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)