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.
When &ital(size) is greater than zero, the message allocated will have at least
the indicated number of bytes in the payload.
There is no maximum size imposed by RMR, however the underlying system memory
When &ital(size) is greater than zero, the message allocated will have at least
the indicated number of bytes in the payload.
There is no maximum size imposed by RMR, however the underlying system memory
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
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
When the state is &cw(RMR_OK) the buffer represents an empty buffer that the application
may fill in in preparation to send.
When the state is &cw(RMR_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 RMR library will route the message.
For a buffer which has been received, this field will contain the message type that was
set by the sending application.
to the appropriate message type value (as determined by the user programme). Upon send
this value determines how the RMR library will route the message.
For a buffer which has been received, this field will contain the message type that was
set by the sending application.
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
call, this will be the value that the sending application supplied and should
indicate the number of bytes in the payload which are valid.
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
call, this will be the value that the sending application supplied and should
indicate the number of bytes in the payload which are valid.
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)
or &cw(rmr_reply) function call.
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)
or &cw(rmr_reply) function call.
the message into which the user may write a transaction ID.
The ID is optional with the exception of when the user application uses the &cw(rmr_call)
function to send a message and wait for the reply; the underlying RMR processing
expects that the matching reply message will also contain the same data in the
&ital(xaction) field.
the message into which the user may write a transaction ID.
The ID is optional with the exception of when the user application uses the &cw(rmr_call)
function to send a message and wait for the reply; the underlying RMR processing
expects that the matching reply message will also contain the same data in the
&ital(xaction) field.
This value is the subscription ID. It, in combination with the message type is used
by rmr to determine the target endpoint when sending a message.
If the application to application protocol does not warrant the use of a subscription
This value is the subscription ID. It, in combination with the message type is used
by rmr to determine the target endpoint when sending a message.
If the application to application protocol does not warrant the use of a subscription
When an application is forwarding or returning a buffer to the sender, it is the
application's responsibility to set/reset this value.
When an application is forwarding or returning a buffer to the sender, it is the
application's responsibility to set/reset this value.
For C applications making use of RMR, the state of a transport based failure will
often be available via &cw(errno.)
However, some wrapper environments may not have direct access to the C-lib &cw(errno)
For C applications making use of RMR, the state of a transport based failure will
often be available via &cw(errno.)
However, some wrapper environments may not have direct access to the C-lib &cw(errno)