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=fa454008020483ac35e1d20300cddfe877d8dd6d;hp=9f0a2cd3480a6f748522131df24d69b2a1f48749;hpb=392168d467d7949f391602f53f9fd62d2a64d12b;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 9f0a2cd..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.