X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=doc%2Fsrc%2Fman%2Frmr_ready.3.xfm;h=a846749cbb513bf459feaa904568b984db6ed779;hb=2d9d6784b306047e94ca9816813e5007b00fd17e;hp=61ea2f884a656e4461cf6bd8528db865e966f853;hpb=523a17b2ea5e380b5360e00828556e8b3872e33d;p=ric-plt%2Flib%2Frmr.git diff --git a/doc/src/man/rmr_ready.3.xfm b/doc/src/man/rmr_ready.3.xfm index 61ea2f8..a846749 100644 --- a/doc/src/man/rmr_ready.3.xfm +++ b/doc/src/man/rmr_ready.3.xfm @@ -1,7 +1,7 @@ .if false ================================================================================== - Copyright (c) 2019 Nokia - Copyright (c) 2018-2019 AT&T Intellectual Property. + Copyright (c) 2019 Nokia + Copyright (c) 2018-2019 AT&T Intellectual Property. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. @@ -17,20 +17,20 @@ ================================================================================== .fi .if false - Mnemonic rmr_ready_man.xfm - Abstract The manual page for the rmr_ready function. - Author E. Scott Daniels - Date 28 January 2019 + Mnemonic rmr_ready_man.xfm + Abstract The manual page for the rmr_ready function. + Author E. Scott Daniels + Date 28 January 2019 .fi .gv e LIB lib -.im &{lib}/man/setup.im +.im &{lib}/man/setup.im &line_len(6i) &h1(RMR Library Functions) &h2(NAME) - rmr_ready + rmr_ready &h2(SYNOPSIS ) &indent @@ -48,7 +48,7 @@ The return value indicates the state of readiness. &h2(RETURN VALUE) A return value of 1 (true) indicates that the routing table is in place and -attempts to send messages can be made. +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 &ital(no endpoint) errors. @@ -70,6 +70,3 @@ rmr_mk_ring(3), rmr_ring_free(3) .ju on - -.qu -