Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
- Mnemonic rmr_tralloc_msg.xfm
- Abstract The manual page for the rmr_tralloc_msg function.
- Author E. Scott Daniels
- Date 19 April 2019
+ Mnemonic rmr_tralloc_msg.xfm
+ Abstract The manual page for the rmr_tralloc_msg function.
+ Author E. Scott Daniels
+ Date 19 April 2019
-The &cw(rmr_alloc_msg) function is used to allocate a buffer which the user
-programme can write into and then send through the a library.
+The &cw(rmr_tralloc_msg) function is used to allocate a buffer which the user
+programme can write into and then send through the library.
-The &ital(size) parameter is used to set the payload length in the message and
-If it is 0, then the default size supplied on the &ital(rmr_init) call will be used.
-In addition to allocating the payload, a space in the buffer is
+The &ital(size) parameter is used to set the payload length in the message.
+If it is 0, then the default size supplied on the &ital(rmr_init) call will be used.
+In addition to allocating the payload, a space in the buffer is
reserved for &ital(trace) data (tr_size bytes), and the bytes pointed to
by &ital(tr_data) are copied into that portion of the message.
reserved for &ital(trace) data (tr_size bytes), and the bytes pointed to
by &ital(tr_data) are copied into that portion of the message.
user application visible fields; the structure is described in &cw(rmr.h,)
and is illustrated below.
user application visible fields; the structure is described in &cw(rmr.h,)
and is illustrated below.
the state indicates whether the buffer was successfully sent which determines
exactly what the payload points to. If the send failed, the payload referenced
the state indicates whether the buffer was successfully sent which determines
exactly what the payload points to. If the send failed, the payload referenced
-by the buffer is the message that failed to send (allowing the application to
-attempt a retransmission).
+by the buffer is the message that failed to send (allowing the application to
+attempt a retransmission).
When the state is &cw(a_OK) the buffer represents an empty buffer that the application
may fill in in preparation to send.
When the state is &cw(a_OK) the buffer represents an empty buffer that the application
may fill in in preparation to send.
to the appropriate message type value (as determined by the user programme). Upon send
this value determines how the a library will route the message.
For a buffer which has been received, this field will contain the message type that was
to the appropriate message type value (as determined by the user programme). Upon send
this value determines how the a library will route the message.
For a buffer which has been received, this field will contain the message type that was
&half_space
&diitem(len ) The application using a buffer to send a message is expected to set the
length value to the actual number of bytes that it placed into the message. This
is likely less than the total number of bytes that the message can carry.
For a message buffer that is passed to the application as the result of a receive
&half_space
&diitem(len ) The application using a buffer to send a message is expected to set the
length value to the actual number of bytes that it placed into the message. This
is likely less than the total number of bytes that the message can carry.
For a message buffer that is passed to the application as the result of a receive
indicate the number of bytes in the payload which are valid.
&half_space
&diitem(payload ) The payload is a pointer to the actual received data. The
user programme may read and write from/to the memory referenced by the payload
up until the point in time that the buffer is used on a &cw(rmr_send, rmr_call)
indicate the number of bytes in the payload which are valid.
&half_space
&diitem(payload ) The payload is a pointer to the actual received data. The
user programme may read and write from/to the memory referenced by the payload
up until the point in time that the buffer is used on a &cw(rmr_send, rmr_call)
Once the buffer has been passed back to a a library function the user programme
should &bold(NOT) make use of the payload pointer.
&half_space
Once the buffer has been passed back to a a library function the user programme
should &bold(NOT) make use of the payload pointer.
&half_space
-&diitem(xaction) The &ital(xaction) field is a pointer to a fixed sized area in
-the message into which the user may write a transaction ID.
+&diitem(xaction) The &ital(xaction) field is a pointer to a fixed sized area in
+the message into which the user may write a transaction ID.