Add ability for RMR to request route table

[ric-plt/lib/rmr.git] / doc / src / man / rmr_rcv_msg.3.xfm

diff --git a/doc/src/man/rmr_rcv_msg.3.xfm b/doc/src/man/rmr_rcv_msg.3.xfm
index b67b4bb..c53dcf5 100644 (file)
--- a/doc/src/man/rmr_rcv_msg.3.xfm
+++ b/doc/src/man/rmr_rcv_msg.3.xfm
@@ -61,7 +61,32 @@ the message information (state, length, payload), or a NULL pointer in the case
 of an extreme error.
 
 &h2(ERRORS)
-The &ital(state) field in the message buffer will indicate either &cw(RMR_OK) or
+The &ital(state) field in the message buffer will indicate either &cw(RMR_OK) 
+when the message receive process was successful and the message can be used
+by the caller.
+Depending on the underlying transport mechanism, one of the following RMR 
+error stats may be returned:
+&half_space
+
+&beg_dlist(.75i : ^&bold_font )
+&di(RMR_ERR_EMPTY) The message received had no payload, or was completely empty.
+
+&half_space
+&di(RMR_ERR_TIMEOUT) For some transport mechanisms, or if reading the receive
+queue from multiple threads, it is possible for one thread to find no data
+waiting when it queries the queue.  When this state is reported, the 
+message buffer does not contain message data and the user application should
+reinvoke the receive function.
+&end_dlist
+
+&space
+
+
+When an RMR error state is reported, the underlying &cw(errno) value might
+provide more information. The following is a list of possible values that
+might accompany the states listed above:
+
+&half_space
 &cw(RMR_ERR_EMPTY) if an empty message was received. 
 If a nil pointer is returned, or any other state value was set in the message
 buffer,  &cw(errno) will be set to one of the following: