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