X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;ds=sidebyside;f=docs%2Frmr_set_fack.3.rst;h=10cdf592a54c1437d16bbb9620b8b116593d4dc5;hb=c752bd3585297dac74faf2a56512556bf140300e;hp=01b8ae3d73ca3265d0b977e7fe4fa44f898ba91b;hpb=503fe41e88b66ff8986c991bfbd075331b0bd166;p=ric-plt%2Flib%2Frmr.git diff --git a/docs/rmr_set_fack.3.rst b/docs/rmr_set_fack.3.rst index 01b8ae3..10cdf59 100644 --- a/docs/rmr_set_fack.3.rst +++ b/docs/rmr_set_fack.3.rst @@ -1,55 +1,62 @@ - - -.. 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_fack -============================================================================================ - -RMR Library Functions -============================================================================================ - - -NAME --------------------------------------------------------------------------------------------- - -rmr_set_fack - -SYNOPSIS --------------------------------------------------------------------------------------------- - - -:: - - #include - void rmr_set_fack( void* vctx ); - - - -DESCRIPTION --------------------------------------------------------------------------------------------- - -The rmr_set_fack function enables *fast TCP acknowledgements* -if the underlying transport library supports it. This might -be useful for applications which must send messages at a -maximum rate. - -RETURN VALUE --------------------------------------------------------------------------------------------- - -There is no return value. - -ERRORS --------------------------------------------------------------------------------------------- - -This function does not generate any errors. - -SEE ALSO --------------------------------------------------------------------------------------------- - -rmr_init(3), +.. 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_fack +============================================================================================ + + + + +RMR LIBRARY FUNCTIONS +===================== + + + +NAME +---- + +rmr_set_fack + + +SYNOPSIS +-------- + + +:: + + #include + + void rmr_set_fack( void* vctx ); + + + + +DESCRIPTION +----------- + +The ``rmr_set_fack`` function enables *fast TCP +acknowledgements* if the underlying transport library +supports it. This might be useful for applications which must +send messages at a maximum rate. + + +RETURN VALUE +------------ + +There is no return value. + + +ERRORS +------ + +This function does not generate any errors. + + +SEE ALSO +-------- + +rmr_init(3),