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