doc/src/man/rmr_rts_msg.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 .if false
  20         Mnemonic        rmr_rts_msg_man.xfm
  21         Abstract        The manual page for the rmr_rts_msg function.
  22         Author          E. Scott Daniels
  23         Date            28 January 2019
  24 .fi
  25
  26 .gv e LIB lib
  27 .im &{lib}/man/setup.im
  28
  29 &line_len(6i)
  30
  31 &h1(RMR Library Functions)
  32 &h2(NAME)
  33         rmr_rts_msg
  34
  35 &h2(SYNOPSIS )
  36 &indent
  37 &ex_start
  38 #include <rmr/rmr.h>
  39
  40 rmr_mbuf_t*  rmr_rts_msg( void* vctx, rmr_mbuf_t* msg );
  41 &ex_end
  42 &uindent
  43
  44 &h2(DESCRIPTION)
  45 The &cw(rmr_rts_msg) function sends a message returning it to the endpoint
  46 which sent the message rather than selecting an endpoint based on the
  47 message type and routing table.
  48 Other than this small difference, the behaviour is exactly the same as
  49 &cw(rmr_send_msg.)
  50
  51 .** pull in common retry text
  52 .im &{lib}/man/retry.im
  53
  54 &h2(RETURN VALUE)
  55 On success, a new message buffer, with an empty payload, is returned for the application
  56 to use for the next send.
  57 The state in this buffer will reflect the overall send operation state and should be
  58 &cw(RMR_OK.)
  59
  60 &space
  61 If the state in the returned buffer is anything other than &cw(UT_OK,) the user application
  62 may need to attempt a retransmission of the message, or take other action depending on the
  63 setting of &cw(errno) as described below.
  64
  65 &space
  66 In the event of extreme failure, a NULL pointer is returned. In this case the value of
  67 &cw(errno) might be of some use, for documentation, but there will be little that the
  68 user application can do other than to move on.
  69
  70 &h2(ERRORS)
  71 The following values may be passed back in the &ital(state) field of the returned message
  72 buffer.
  73
  74 &space
  75 &beg_dlist(.75i : ^&bold_font )
  76 &di(RMR_ERR_BADARG) The message buffer pointer did not refer to a valid message.
  77 &di(RMR_ERR_NOHDR)  The header in the message buffer was not valid or corrupted.
  78 &di(RMR_ERR_NOENDPT)  The message type in the message buffer did not map to a known endpoint.
  79 &di(RMR_ERR_SENDFAILED)  The send failed; &cw(errno) has the possible reason.
  80 &end_dlist
  81
  82 &space
  83 The following values may be assigned to &cw(errno) on failure.
  84 &beg_dlist(.75i : ^&bold_font )
  85 &di(INVAL) Parameter(s) passed to the function were not valid, or the underlying message processing environment was unable to interpret the message.
  86
  87 &half_space
  88 &di(ENOKEY) The header information in the message buffer was invalid.
  89
  90 &half_space
  91 &di(ENXIO) No known endpoint for the message could be found.
  92
  93 &half_space
  94 &di(EMSGSIZE) The underlying transport refused to accept the message because of a size value issue (message was not attempted to be sent).
  95
  96 &half_space
  97 &di(EFAULT) The message referenced by the message buffer is corrupt (NULL pointer or bad internal length).
  98
  99 &half_space
 100 &di(EBADF) Internal RMR error; information provided to the message transport environment was not valid.
 101
 102 &half_space
 103 &di(ENOTSUP) Sending was not supported by the underlying message transport.
 104
 105 &half_space
 106 &di(EFSM) The device is not in a state that can accept the message.
 107
 108 &half_space
 109 &di(EAGAIN) The device is not able to accept a message for sending. The user application should attempt to resend.
 110
 111 &half_space
 112 &di(EINTR) The operation was interrupted by delivery of a signal before the message was sent.
 113
 114 &half_space
 115 &di(ETIMEDOUT) The underlying message environment timed out during the send process.
 116
 117 &half_space
 118 &di(ETERM) The underlying message environment is in a shutdown state.
 119 &end_dlist
 120
 121 &h2(EXAMPLE)
 122
 123 &h2(SEE ALSO )
 124 .ju off
 125 rmr_alloc_msg(3),
 126 rmr_call(3),
 127 rmr_free_msg(3),
 128 rmr_init(3),
 129 rmr_payload_size(3),
 130 rmr_send_msg(3),
 131 rmr_rcv_msg(3),
 132 rmr_rcv_specific(3),
 133 rmr_ready(3),
 134 rmr_fib(3),
 135 rmr_has_str(3),
 136 rmr_set_stimeout(3),
 137 rmr_tokenise(3),
 138 rmr_mk_ring(3),
 139 rmr_ring_free(3)
 140 .ju on
 141
 142
 143 .qu
 144