2 ==================================================================================
3 Copyright (c) 2019 Nokia
4 Copyright (c) 2018-2019 AT&T Intellectual Property.
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
10 http://www.apache.org/licenses/LICENSE-2.0
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 ==================================================================================
20 Mnemonic rmr_ready_man.xfm
21 Abstract The manual page for the rmr_ready function.
22 Author E. Scott Daniels
26 .** if formatting with tfm, the roff.im will cause roff output to be generated
27 .** if formatting with pfm, then pretty postscript will be generated
30 .im &{lib}/generic_ps.im
32 .gv e OUTPUT_RST use_rst
42 &h1(RMR Library Functions)
51 int rmr_ready( void* vctx );
56 The &cw(rmr_ready) function checks to see if a routing table has been successfully
57 received and installed.
58 The return value indicates the state of readiness.
61 A return value of 1 (true) indicates that the routing table is in place and
62 attempts to send messages can be made.
63 When 0 is returned (false) the routing table has not been received and thus
64 attempts to send messages will fail with &ital(no endpoint) errors.