X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=doc%2Fsrc%2Fman%2Frmr_tralloc_msg.3.xfm;h=da7ac6bf122f0c15709c12e7497b77237cf9c271;hb=190665fe57168a4b9d544b88d3f69797f258c04c;hp=0f26cf1ac126dcfe02fc98e6dbaa127cc6d917ba;hpb=523a17b2ea5e380b5360e00828556e8b3872e33d;p=ric-plt%2Flib%2Frmr.git diff --git a/doc/src/man/rmr_tralloc_msg.3.xfm b/doc/src/man/rmr_tralloc_msg.3.xfm index 0f26cf1..da7ac6b 100644 --- a/doc/src/man/rmr_tralloc_msg.3.xfm +++ b/doc/src/man/rmr_tralloc_msg.3.xfm @@ -77,7 +77,7 @@ typedef struct { &space &beg_dlist(.75i : ^&bold_font ) -&ditem(state ) Is the current buffer state. Following a call to &cw(rmr_send_msg) +&diitem(state ) Is the current buffer state. Following a call to &cw(rmr_send_msg) 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 @@ -86,14 +86,14 @@ When the state is &cw(a_OK) the buffer represents an empty buffer that the appli may fill in in preparation to send. &half_space -&ditem(mtype ) When sending a message, the application is expected to set this field +&diitem(mtype ) When sending a message, the application is expected to set this field 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 set by the sending application. &half_space -&ditem(len ) The application using a buffer to send a message is expected to set the +&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 @@ -101,7 +101,7 @@ call, this will be the value that the sending application supplied and should indicate the number of bytes in the payload which are valid. &half_space -&ditem(payload ) The payload is a pointer to the actual received data. The +&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) or &cw(rmr_reply) function call. @@ -110,7 +110,7 @@ should &bold(NOT) make use of the payload pointer. &half_space -&ditem(xaction) The &ital(xaction) field is a pointer to a fixed sized area in +&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. 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 a processing @@ -129,6 +129,7 @@ The function returns a pointer to a &cw(rmr_mbuf) structure, or NULL on error. .** &h2(EXAMPLE) &h2(SEE ALSO ) +.ju off rmr_alloc_msg(3), rmr_mbuf(3) rmr_call(3), @@ -149,7 +150,5 @@ rmr_tokenise(3), rmr_mk_ring(3), rmr_ring_free(3), rmr_set_trace(3) - - -.qu +.ju on