docs/rmr_set_low_lat.3.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. CAUTION: this document is generated from source in doc/src/rtd.
   4 .. To make changes edit the source and recompile the document.
   5 .. Do NOT make changes directly to .rst or .md files.
   6
   7 ============================================================================================
   8 Man Page: rmr_set_low_lat
   9 ============================================================================================
  10
  11
  12
  13
  14 RMR LIBRARY FUNCTIONS
  15 =====================
  16
  17
  18
  19 NAME
  20 ----
  21
  22 rmr_set_low_latency
  23
  24
  25 SYNOPSIS
  26 --------
  27
  28
  29 ::
  30
  31   #include <rmr/rmr.h>
  32
  33   void rmr_set_low_latency( void* vctx );
  34
  35
  36
  37
  38 DESCRIPTION
  39 -----------
  40
  41 The ``rmr_set_low_latency`` function enables *TCP NO_DELAY*
  42 if the underlying transport library supports it. This might
  43 be useful for applications which must send messages at a
  44 maximum rate.
  45
  46 A call to this function will cause all subsequent connections
  47 made by the application to set the no delay (low latency)
  48 option. When no delay is needed, it is recommended that this
  49 function be called immediately upon a successful call to the
  50 RMR initialisation function.
  51
  52 The effect of setting "low latency" mode is to disable
  53 Nagel's algorithm and to send a packet on a connection as
  54 soon as it is given to the TCP transport. When this option is
  55 not enabled, TCP may employ Nagel's algorithm and hold the
  56 packet with the assumption that it can be combined with
  57 another and sent in the same datagram in an effort to improve
  58 bandwidth but at the expense of added latency.
  59
  60
  61 RETURN VALUE
  62 ------------
  63
  64 There is no return value.
  65
  66
  67 ERRORS
  68 ------
  69
  70 This function does not generate any errors.
  71
  72
  73 SEE ALSO
  74 --------
  75
  76 rmr_init(3), rmr_fast_ack(3)