doc/src/man/rmr_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_close.3.xfm
  22         Abstract        The manual page for the rmr_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 )
  42 &ex_end
  43
  44 &uindent
  45
  46 &h2(DESCRIPTION)
  47 The &cw(rmr_close) function closes the listen socket effectively cutting the application
  48 off.
  49 The route table listener is also stopped.
  50 Calls to rmr_rcv_msg() will fail with unpredictable error codes, and calls to rmr_send_msg(),
  51 rmr_call(), and rmr_rts_msg() will have unknown results.
  52
  53 .sp
  54
  55
  56 &h2(SEE ALSO )
  57 .ju off
  58 rmr_alloc_msg(3),
  59 rmr_call(3),
  60 rmr_free_msg(3),
  61 rmr_get_rcvfd(3),
  62 rmr_payload_size(3),
  63 rmr_send_msg(3),
  64 rmr_rcv_msg(3),
  65 rmr_rcv_specific(3),
  66 rmr_rts_msg(3),
  67 rmr_ready(3),
  68 rmr_fib(3),
  69 rmr_has_str(3),
  70 rmr_tokenise(3),
  71 rmr_mk_ring(3),
  72 rmr_ring_free(3),
  73 rmr_wh_open(3),
  74 rmr_wh_send_msg(3)
  75 .ju on