docs/rmr_close.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_close
  12 ============================================================================================
  13
  14 RMR Library Functions
  15 ============================================================================================
  16
  17
  18 NAME
  19 --------------------------------------------------------------------------------------------
  20
  21 rmr_close
  22
  23 SYNOPSIS
  24 --------------------------------------------------------------------------------------------
  25
  26
  27 ::
  28
  29  #include <rmr/rmr.h>
  30  void rmr_close( void* vctx )
  31
  32
  33
  34 DESCRIPTION
  35 --------------------------------------------------------------------------------------------
  36
  37 The rmr_close function closes the listen socket effectively
  38 cutting the application off. The route table listener is also
  39 stopped. Calls to rmr_rcv_msg() will fail with unpredictable
  40 error codes, and calls to rmr_send_msg(), rmr_call(), and
  41 rmr_rts_msg() will have unknown results.
  42
  43
  44 SEE ALSO
  45 --------------------------------------------------------------------------------------------
  46
  47 rmr_alloc_msg(3), rmr_call(3), rmr_free_msg(3),
  48 rmr_get_rcvfd(3), rmr_payload_size(3), rmr_send_msg(3),
  49 rmr_rcv_msg(3), rmr_rcv_specific(3), rmr_rts_msg(3),
  50 rmr_ready(3), rmr_fib(3), rmr_has_str(3), rmr_tokenise(3),
  51 rmr_mk_ring(3), rmr_ring_free(3), rmr_wh_open(3),
  52 rmr_wh_send_msg(3)