doc/src/man/rmr_alloc_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_alloc_msg.xfm
  21         Abstract        The manual page for the rmr_alloc_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 &h1(RMR Library Functions)
  31 &h2(NAME)
  32         rmr_alloc_msg
  33
  34 &h2(SYNOPSIS )
  35 &indent
  36 &ex_start
  37 #include <rmr/rmr.h>
  38
  39 rmr_mbuf_t* rmr_alloc_msg( void* ctx, int size );
  40 &ex_end
  41 &uindent
  42
  43 &h2(DESCRIPTION)
  44 The &cw(rmr_alloc_msg) function is used to allocate a buffer which the user
  45 programme can write into and then send through the RMR library.
  46 The buffer is allocated such that sending it requires no additional copying
  47 out of the buffer.
  48 If the value passed in &cw(size) is 0, then the default size supplied on the
  49 &ital(rmr_init) call will be used.
  50 The &ital(ctx) parameter is the void context pointer that was returned by
  51 the &ital(rmr_init) function.
  52
  53 &space
  54 The pointer to the message buffer returned is a structure which has some
  55 user application visible fields; the structure is described in &cw(rmr.h,)
  56 and is illustrated below.
  57
  58 &space
  59 &ex_start
  60 typedef struct {
  61     int state;
  62     int mtype;
  63     int len;
  64     unsigned char* payload;
  65     unsigned char* xaction;
  66 } rmr_mbuf_t;
  67 &ex_end
  68
  69 &space
  70 &beg_dlist(.75i : ^&bold_font )
  71 &ditem(state )  Is the current buffer state.  Following a call to &cw(rmr_send_msg)
  72 the state indicates whether the buffer was successfully sent which determines
  73 exactly what the payload points to.  If the send failed, the payload referenced
  74 by the buffer is the message that failed to send (allowing the application to
  75 attempt a retransmission).
  76 When the state is &cw(RMR_OK) the buffer represents an empty buffer that the application
  77 may fill in in preparation to send.
  78
  79 &half_space
  80 &ditem(mtype )  When sending a message, the application is expected to set this field
  81 to the appropriate message type value (as determined by the user programme). Upon send
  82 this value determines how the RMR library will route the message.
  83 For a buffer which has been received, this field will contain the message type that was
  84 set by the sending application.
  85
  86 &half_space
  87 &ditem(len ) The application using a buffer to send a message is expected to set the
  88 length value to the actual number of bytes that it placed into the message. This
  89 is likely less than the total number of bytes that the message can carry.
  90 For a message buffer that is passed to the application as the result of a receive
  91 call, this will be the value that the sending application supplied and should
  92 indicate the number of bytes in the payload which are valid.
  93
  94 &half_space
  95 &ditem(payload ) The payload is a pointer to the actual received data.  The
  96 user programme may read and write from/to the memory referenced by the payload
  97 up until the point in time that the buffer is used on a &cw(rmr_send, rmr_call)
  98 or &cw(rmr_reply) function call.
  99 Once the buffer has been passed back to a RMR library function the user programme
 100 should &bold(NOT) make use of the payload pointer.
 101
 102
 103 &half_space
 104 &ditem(xaction) The &ital(xaction) field is a pointer to a fixed sized area in
 105 the message into which the user may write a transaction ID.
 106 The ID is optional with the exception of when the user application uses the &cw(rmr_call)
 107 function to send a message and wait for the reply; the underlying RMR processing
 108 expects that the matching reply message will also contain the same data in the
 109 &ital(xaction) field.
 110 &end_dlist
 111
 112 &h2(RETURN VALUE)
 113 The function returns a pointer to a &cw(rmr_mbuf) structure, or NULL on error.
 114
 115 &h2(ERRORS)
 116 &beg_dlist(.75i : ^&bold_font )
 117 &di(ENOMEM) Unable to allocate memory.
 118 &end_dlist
 119
 120 .** &h2(EXAMPLE)
 121
 122 &h2(SEE ALSO )
 123 rmr_tralloc_msg(3),
 124 rmr_call(3),
 125 rmr_free_msg(3),
 126 rmr_init(3),
 127 rmr_init_trace(3),
 128 rmr_get_trace(3),
 129 rmr_get_trlen(3),
 130 rmr_payload_size(3),
 131 rmr_send_msg(3),
 132 rmr_rcv_msg(3),
 133 rmr_rcv_specific(3),
 134 rmr_rts_msg(3),
 135 rmr_ready(3),
 136 rmr_fib(3),
 137 rmr_has_str(3),
 138 rmr_tokenise(3),
 139 rmr_mk_ring(3),
 140 rmr_ring_free(3),
 141 rmr_set_trace(3)
 142
 143 .qu
 144