X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=doc%2Fsrc%2Fman%2Frmr_tralloc_msg.3.xfm;h=76c65d1cfa315a57e4ae49a4b2c0c1c95ee0d911;hb=a3a121ca4a0426ec964fa684fb27c397f2ee9e24;hp=cd0d9c5cabba2e8ce9640a739c7117a0d759c630;hpb=2b3c393e660c5e1037191f43cc70537da8316b89;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 cd0d9c5..76c65d1 100644 --- a/doc/src/man/rmr_tralloc_msg.3.xfm +++ b/doc/src/man/rmr_tralloc_msg.3.xfm @@ -1,7 +1,7 @@ .if false ================================================================================== - Copyright (c) 2019 Nokia - Copyright (c) 2018-2019 AT&T Intellectual Property. + Copyright (c) 2019-2020 Nokia + Copyright (c) 2018-2020 AT&T Intellectual Property. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. @@ -76,46 +76,44 @@ typedef struct { &ex_end &space -&beg_dlist(.75i : ^&bold_font ) -&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 -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. - +Where: &half_space -&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 -&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 -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 -&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. -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. -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 processing -expects that the matching reply message will also contain the same data in the -&ital(xaction) field. +&beg_dlist(.75i : ^&bold_font ) +&ditem(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 + 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. + +&ditem(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. + +&ditem(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 + call, this will be the value that the sending application supplied and should + indicate the number of bytes in the payload which are valid. + +&ditem(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. + Once the buffer has been passed back to a a library function the user programme + should &bold(NOT) make use of the payload pointer. + +&ditem(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 processing + expects that the matching reply message will also contain the same data in the + &ital(xaction) field. &end_dlist &h2(RETURN VALUE) @@ -123,7 +121,7 @@ The function returns a pointer to a &cw(rmr_mbuf) structure, or NULL on error. &h2(ERRORS) &beg_dlist(.75i : ^&bold_font ) -&di(ENOMEM) Unable to allocate memory. +&ditem(ENOMEM) Unable to allocate memory. &end_dlist .** &h2(EXAMPLE)