doc/src/man/rmr_str2xact.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_str2xact.xfm
  22         Abstract        The manual page for the rmr_str2xact function.
  23         Author          E. Scott Daniels
  24         Date            8 March 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_str2xact
  35
  36 &h2(SYNOPSIS)
  37 &indent
  38 &ex_start
  39 #include <rmr/rmr.h>
  40
  41 int rmr_str2xact( rmr_mbuf_t* mbuf, unsigned char* src, int len )
  42 &ex_end
  43
  44 &uindent
  45
  46 &h2(DESCRIPTION)
  47 The &cw(rmr_str2xact) function will copy the string pointed to by src to the
  48 transaction ID (xaction) field in the given message.
  49 The field is a fixed length, gated by the constant &cw(RMR_MAX_XID) and if string length is larger
  50 than this value, then &bold(nothing) will be copied. (Note, this differs slightly from the
  51 behaviour of the &cw( lrmr_bytes2xact() ) function.)
  52
  53 &beg_dlist(.75i : ^&bold_font )
  54 &h2(RETURN VALUE)
  55 On success, the value RMR_OK is returned.
  56 If the string cannot be copied to the message, the return value will be one of the
  57 errors listed below.
  58
  59 &h2(ERRORS)
  60 If the return value is not RMR_OK, then it will be set to one of the values below.
  61
  62 &half_space
  63 &di(RMR_ERR_BADARG) The message, or an internal portion of the message, was corrupted or the pointer was invalid.
  64
  65 &half_space
  66 &di(RMR_ERR_OVERFLOW) The length passed in was larger than the maximum length of the field; only a portion of
  67         the source bytes were copied.
  68 &end_dlist
  69
  70 &h2(EXAMPLE)
  71
  72
  73 &h2(SEE ALSO )
  74 .ju off
  75 rmr_alloc_msg(3),
  76 rmr_bytes2meid(3),
  77 rmr_bytes2xact(3),
  78 rmr_call(3),
  79 rmr_free_msg(3),
  80 rmr_get_meid(3),
  81 rmr_get_rcvfd(3),
  82 rmr_get_xact(3),
  83 rmr_payload_size(3),
  84 rmr_send_msg(3),
  85 rmr_rcv_msg(3),
  86 rmr_rcv_specific(3),
  87 rmr_rts_msg(3),
  88 rmr_ready(3),
  89 rmr_fib(3),
  90 rmr_has_str(3),
  91 rmr_tokenise(3),
  92 rmr_mk_ring(3),
  93 rmr_ring_free(3),
  94 rmr_str2meid(3),
  95 rmr_wh_open(3),
  96 rmr_wh_send_msg(3)
  97 .ju on
  98