Add wormhole state check function
[ric-plt/lib/rmr.git] / doc / src / man / rmr_set_fack.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_fack.3.xfm
21         Abstract        The manual page for the set fast ack function.
22         Author          E. Scott Daniels
23         Date            19 Fabruary 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_fack
34
35 &h2(SYNOPSIS )
36 &indent
37 &ex_start
38 #include <rmr/rmr.h>
39
40 void rmr_set_fack( void* vctx );
41
42 &ex_end
43 &uindent
44
45 &h2(DESCRIPTION)
46 The &cw(rmr_set_fack) function enables &ital(fast TCP acknowledgements) if
47 the underlying transport library supports it. 
48 This might be useful for applications which must send messages as a maximum
49 rate. 
50
51 &h2(RETURN VALUE)
52 There is no return value.
53
54
55 &h2(ERRORS)
56 This function does not generate any errors.
57
58 &h2(SEE ALSO )
59 .ju off
60 rmr_init(3),
61 .ju on
62