X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=doc%2Fsrc%2Fman%2Frmr_send_msg.3.xfm;h=36812c03bfd453c355cb007204b3a3f3372a9435;hb=190665fe57168a4b9d544b88d3f69797f258c04c;hp=64977812901d452bb03f3bc91b1f6a5e9387fdbd;hpb=fd9cc7a5b3355146388ebdf4d558cb284c66c5f1;p=ric-plt%2Flib%2Frmr.git

diff --git a/doc/src/man/rmr_send_msg.3.xfm b/doc/src/man/rmr_send_msg.3.xfm
index 6497781..36812c0 100644
--- a/doc/src/man/rmr_send_msg.3.xfm
+++ b/doc/src/man/rmr_send_msg.3.xfm
@@ -23,19 +23,8 @@
 	Date		28 January 2019
 .fi
 
-.** if formatting with tfm, the roff.im will cause roff output to be generated
-.** if formatting with pfm, then pretty postscript will be generated
 .gv e LIB lib
-.if pfm
-	.im &{lib}/generic_ps.im
-.ei
-	.gv e OUTPUT_RST use_rst
-	.if .ev &use_rst 1 = 
-		.im &{lib}/rst.im
-	.ei
-		.im &{lib}/roff.im
-	.fi
-.fi
+.im &{lib}/man/setup.im 
 
 &line_len(6i)
 
@@ -65,6 +54,10 @@ responsible for building the routing table used by the RMR library, and not the
 responsibility of the library.)
 
 
+.** pull in common retry text
+.im &{lib}/man/retry.im 
+
+
 &h2(RETURN VALUE)
 On success, a new message buffer, with an empty payload, is returned for the application
 to use for the next send.
@@ -72,9 +65,10 @@ The state in this buffer will reflect the overall send operation state and shoul
 &cw(RMR_OK.)
 
 &space
-If the state in the returned buffer is anything other than &cw(UT_OK,) the user application 
-may need to attempt a retransmission of the message, or take other action depending on the
-setting of &cw(errno) as described below. 
+When the message cannot be successfully sent this function will return the unsent (original) 
+message buffer with the state set to indicate the reason for failure.  
+The value of &ital(errno) may also be set to reflect a more detailed failure reason if it
+is known.
 
 &space
 In the event of extreme failure, a NULL pointer is returned. In this case the value of 
@@ -87,6 +81,11 @@ buffer.
 
 &space
 &beg_dlist(.75i : ^&bold_font )
+&di(RMR_RETRY) 	The message could not be sent, but the underlying transport mechanism
+	indicates that the failure is temporary. If the send operation is tried again
+	it might be successful.
+&di(RMR_SEND_FAILED) The send operation was not successful and the underlying transport
+	mechanism indicates a permanent (hard) failure; retrying the send is not possible.
 &di(RMR_ERR_BADARG) The message buffer pointer did not refer to a valid message.
 &di(RMR_ERR_NOHDR)  The header in the message buffer was not valid or corrupted.
 &di(RMR_ERR_NOENDPT)  The message type in the message buffer did not map to a known endpoint.
@@ -183,6 +182,3 @@ rmr_torcv_rcv(3),
 rmr_wh_send_msg(3)
 .ju on
 
-
-.qu
-