doc/src/man/rmr_wh_close.3.xfm

   1 .if false
   2 ==================================================================================
   3         Copyright (c) 2019 Nokia
   4         Copyright (c) 2018-2019 AT&T Intellectual Property.
   5
   6    Licensed under the Apache License, Version 2.0 (the "License");
   7    you may not use this file except in compliance with the License.
   8    You may obtain a copy of the License at
   9
  10        http://www.apache.org/licenses/LICENSE-2.0
  11
  12    Unless required by applicable law or agreed to in writing, software
  13    distributed under the License is distributed on an "AS IS" BASIS,
  14    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15    See the License for the specific language governing permissions and
  16    limitations under the License.
  17 ==================================================================================
  18 .fi
  19
  20 .if false
  21         Mnemonic        rmr_wh_close.xfm
  22         Abstract        The manual page for the rmr_wh_close function.
  23         Author          E. Scott Daniels
  24         Date            21 February 2019
  25 .fi
  26
  27 .gv e LIB lib
  28 .im &{lib}/man/setup.im
  29
  30 &line_len(6i)
  31
  32 &h1(RMR Library Functions)
  33 &h2(NAME)
  34         rmr_wh_open
  35
  36 &h2(SYNOPSIS)
  37 &indent
  38 &ex_start
  39 #include <rmr/rmr.h>
  40
  41 void rmr_close( void* vctx, rmr_whid_t whid )
  42 &ex_end
  43
  44 &uindent
  45
  46 &h2(DESCRIPTION)
  47 The &cw(rmr_wh_close) function closes the wormhole associated with the wormhole id passed
  48 in.
  49 Future calls to &cw(rmr_wh_send_msg) with this ID will fail.
  50
  51 &space
  52 The underlying TCP connection to the remote endpoint is &bold(not) closed as this
  53 session may be reqruired for regularlly routed messages (messages routed based on message
  54 type).
  55 There is no way to force a TCP session to be closed at this point in time.
  56
  57
  58 &h2(SEE ALSO )
  59 .ju off
  60 rmr_alloc_msg(3),
  61 rmr_call(3),
  62 rmr_free_msg(3),
  63 rmr_get_rcvfd(3),
  64 rmr_payload_size(3),
  65 rmr_send_msg(3),
  66 rmr_rcv_msg(3),
  67 rmr_rcv_specific(3),
  68 rmr_rts_msg(3),
  69 rmr_ready(3),
  70 rmr_fib(3),
  71 rmr_has_str(3),
  72 rmr_tokenise(3),
  73 rmr_mk_ring(3),
  74 rmr_ring_free(3),
  75 rmr_wh_open(3),
  76 rmr_wh_send_msg(3)
  77
  78 .ju on