X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;ds=sidebyside;f=docs%2Frmr_ready.3.rst;h=b6b8b0f54311549786dda4abdf069180f56be820;hb=4f3e23473e3453d4b9c24d1cd727c481e5f59c74;hp=e7843b4cebd9fa0262528c4ccfa0e5e4d6dad1aa;hpb=a3a121ca4a0426ec964fa684fb27c397f2ee9e24;p=ric-plt%2Flib%2Frmr.git diff --git a/docs/rmr_ready.3.rst b/docs/rmr_ready.3.rst index e7843b4..b6b8b0f 100644 --- a/docs/rmr_ready.3.rst +++ b/docs/rmr_ready.3.rst @@ -1,14 +1,14 @@ -.. 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_ready -============================================================================================ - - +.. 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_ready +============================================================================================ + + RMR LIBRARY FUNCTIONS @@ -19,44 +19,44 @@ RMR LIBRARY FUNCTIONS NAME ---- -rmr_ready +rmr_ready SYNOPSIS -------- - -:: - - #include - - int rmr_ready( void* vctx ); - + +:: + + #include + + int rmr_ready( void* vctx ); + DESCRIPTION ----------- -The ``rmr_ready`` function checks to see if a routing table -has been successfully received and installed. The return -value indicates the state of readiness. +The ``rmr_ready`` function checks to see if a routing table +has been successfully received and installed. The return +value indicates the state of readiness. RETURN VALUE ------------ -A return value of 1 (true) indicates that the routing table -is in place and attempts to send messages can be made. When 0 -is returned (false) the routing table has not been received -and thus attempts to send messages will fail with *no -endpoint* errors. +A return value of 1 (true) indicates that the routing table +is in place and attempts to send messages can be made. When 0 +is returned (false) the routing table has not been received +and thus attempts to send messages will fail with *no +endpoint* errors. SEE ALSO -------- -rmr_alloc_msg(3), rmr_call(3), rmr_free_msg(3), rmr_init(3), -rmr_payload_size(3), rmr_send_msg(3), rmr_rcv_msg(3), -rmr_rcv_specific(3), rmr_rts_msg(3), rmr_fib(3), -rmr_has_str(3), rmr_tokenise(3), rmr_mk_ring(3), -rmr_ring_free(3) +rmr_alloc_msg(3), rmr_call(3), rmr_free_msg(3), rmr_init(3), +rmr_payload_size(3), rmr_send_msg(3), rmr_rcv_msg(3), +rmr_rcv_specific(3), rmr_rts_msg(3), rmr_fib(3), +rmr_has_str(3), rmr_tokenise(3), rmr_mk_ring(3), +rmr_ring_free(3)