doc/src/man/rmr_ready.3.xfm

   1 .if false
   2 ==================================================================================
   3         Copyright (c) 2019 Nokia
   4         Copyright (c) 2018-2019 AT&T Intellectual Property.
   5
   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
   9
  10        http://www.apache.org/licenses/LICENSE-2.0
  11
  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 ==================================================================================
  18 .fi
  19 .if false
  20         Mnemonic        rmr_ready_man.xfm
  21         Abstract        The manual page for the rmr_ready function.
  22         Author          E. Scott Daniels
  23         Date            28 January 2019
  24 .fi
  25
  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
  28 .gv e LIB lib
  29 .if pfm
  30         .im &{lib}/generic_ps.im
  31 .ei
  32         .gv e OUTPUT_RST use_rst
  33         .if .ev &use_rst 1 =
  34                 .im &{lib}/rst.im
  35         .ei
  36                 .im &{lib}/roff.im
  37         .fi
  38 .fi
  39
  40 &line_len(6i)
  41
  42 &h1(RMR Library Functions)
  43 &h2(NAME)
  44         rmr_ready
  45
  46 &h2(SYNOPSIS )
  47 &indent
  48 &ex_start
  49 #include <rmr/rmr.h>
  50
  51 int rmr_ready( void* vctx );
  52 &ex_end
  53 &uindent
  54
  55 &h2(DESCRIPTION)
  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.
  59
  60 &h2(RETURN VALUE)
  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.
  65
  66 &h2(SEE ALSO )
  67 .ju off
  68 rmr_alloc_msg(3),
  69 rmr_call(3),
  70 rmr_free_msg(3),
  71 rmr_init(3),
  72 rmr_payload_size(3),
  73 rmr_send_msg(3),
  74 rmr_rcv_msg(3),
  75 rmr_rcv_specific(3),
  76 rmr_rts_msg(3),
  77 rmr_fib(3),
  78 rmr_has_str(3),
  79 rmr_tokenise(3),
  80 rmr_mk_ring(3),
  81 rmr_ring_free(3)
  82 .ju on
  83
  84
  85 .qu
  86