docs/rmr_ready.3.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. CAUTION: this document is generated from source in doc/src/rtd.
   4 .. To make changes edit the source and recompile the document.
   5 .. Do NOT make changes directly to .rst or .md files.
   6
   7 ============================================================================================
   8 Man Page: rmr_ready
   9 ============================================================================================
  10
  11
  12
  13
  14 RMR LIBRARY FUNCTIONS
  15 =====================
  16
  17
  18
  19 NAME
  20 ----
  21
  22 rmr_ready
  23
  24
  25 SYNOPSIS
  26 --------
  27
  28
  29 ::
  30
  31   #include <rmr/rmr.h>
  32
  33   int rmr_ready( void* vctx );
  34
  35
  36
  37 DESCRIPTION
  38 -----------
  39
  40 The ``rmr_ready`` function checks to see if a routing table
  41 has been successfully received and installed. The return
  42 value indicates the state of readiness.
  43
  44
  45 RETURN VALUE
  46 ------------
  47
  48 A return value of 1 (true) indicates that the routing table
  49 is in place and attempts to send messages can be made. When 0
  50 is returned (false) the routing table has not been received
  51 and thus attempts to send messages will fail with *no
  52 endpoint* errors.
  53
  54
  55 SEE ALSO
  56 --------
  57
  58 rmr_alloc_msg(3), rmr_call(3), rmr_free_msg(3), rmr_init(3),
  59 rmr_payload_size(3), rmr_send_msg(3), rmr_rcv_msg(3),
  60 rmr_rcv_specific(3), rmr_rts_msg(3), rmr_fib(3),
  61 rmr_has_str(3), rmr_tokenise(3), rmr_mk_ring(3),
  62 rmr_ring_free(3)