docs/rmr_ready.3.rst

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