doc/src/man/rmr_set_low_lat.3.xfm

   1 .if false
   2 ==================================================================================
   3    Copyright (c) 2019-2020 Nokia
   4    Copyright (c) 2018-2020 AT&T Intellectual Property.
   5
   6    Licensed under the Apache License, Version 2.0 (the "License");
   7    you may not use this file except in compliance with the License.
   8    You may obtain a copy of the License at
   9
  10        http://www.apache.org/licenses/LICENSE-2.0
  11
  12    Unless required by applicable law or agreed to in writing, software
  13    distributed under the License is distributed on an "AS IS" BASIS,
  14    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15    See the License for the specific language governing permissions and
  16    limitations under the License.
  17 ==================================================================================
  18 .fi
  19 .if false
  20     Mnemonic    rmr_set_low_lat.3.xfm
  21     Abstract    The manual page for the set low latency (no delay) function.
  22     Author      E. Scott Daniels
  23     Date        21 September 2020
  24 .fi
  25
  26 .gv e LIB lib
  27 .im &{lib}/man/setup.im
  28
  29 &line_len(6i)
  30
  31 &h1(RMR Library Functions)
  32 &h2(NAME)
  33     rmr_set_low_latency
  34
  35 &h2(SYNOPSIS )
  36 &indent
  37 &ex_start
  38 #include <rmr/rmr.h>
  39
  40 void rmr_set_low_latency( void* vctx );
  41
  42 &ex_end
  43 &uindent
  44
  45 &h2(DESCRIPTION)
  46 The &cw(rmr_set_low_latency) function enables &ital(TCP NO_DELAY) if
  47 the underlying transport library supports it.
  48 This might be useful for applications which must send messages at a maximum
  49 rate.
  50
  51 &space
  52 A call to this function will cause all subsequent connections made by the application
  53 to set the no delay (low latency) option.
  54 When no delay is needed, it is recommended that this function be called immediately upon a successful call to
  55 the RMR initialisation function.
  56
  57 &space
  58 The effect of setting "low latency" mode is to disable Nagel's algorithm and to send a packet
  59 on a connection as soon as it is given to the TCP transport.
  60 When this option is not enabled, TCP may employ Nagel's algorithm and hold the packet
  61 with the assumption that it can be combined with another and sent in the same datagram
  62 in an effort to improve bandwidth but at the expense of added latency.
  63
  64 &h2(RETURN VALUE)
  65 There is no return value.
  66
  67
  68 &h2(ERRORS)
  69 This function does not generate any errors.
  70
  71 &h2(SEE ALSO )
  72 .ju off
  73 rmr_init(3), rmr_fast_ack(3)
  74 .ju on
  75