docs/rmr_wh_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_wh_close
   9 ============================================================================================
  10
  11
  12
  13
  14 RMR LIBRARY FUNCTIONS
  15 =====================
  16
  17
  18
  19 NAME
  20 ----
  21
  22 rmr_wh_close
  23
  24
  25 SYNOPSIS
  26 --------
  27
  28
  29 ::
  30
  31   #include <rmr/rmr.h>
  32
  33   void rmr_wh_close( void* vctx, rmr_whid_t whid )
  34
  35
  36
  37 DESCRIPTION
  38 -----------
  39
  40 The ``rmr_wh_close`` function closes the wormhole associated
  41 with the wormhole id passed in. Future calls to
  42 ``rmr_wh_send_msg`` with this ID will fail.
  43
  44 The underlying TCP connection to the remote endpoint is
  45 **not** closed as this session may be required for regularly
  46 routed messages (messages routed based on message type).
  47 There is no way to force a TCP session to be closed at this
  48 point in time.
  49
  50
  51 SEE ALSO
  52 --------
  53
  54 rmr_alloc_msg(3), rmr_call(3), rmr_free_msg(3),
  55 rmr_get_rcvfd(3), rmr_payload_size(3), rmr_send_msg(3),
  56 rmr_rcv_msg(3), rmr_rcv_specific(3), rmr_rts_msg(3),
  57 rmr_ready(3), rmr_fib(3), rmr_has_str(3), rmr_tokenise(3),
  58 rmr_mk_ring(3), rmr_ring_free(3), rmr_wh_open(3),
  59 rmr_wh_send_msg(3)