Correct bug in timeout receive

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

diff --git a/doc/src/man/rmr_torcv_msg.3.xfm b/doc/src/man/rmr_torcv_msg.3.xfm
index b38b9ad..ffe26dc 100644 (file)
--- a/doc/src/man/rmr_torcv_msg.3.xfm
+++ b/doc/src/man/rmr_torcv_msg.3.xfm
@@ -72,6 +72,12 @@ The &ital(state) field in the message buffer will be one of the following:
 &beg_dlist(.75i : ^&bold_font )
 &di(RMR_OK) The message buffer (payload) references the received data.
 
+&space
+&di(RMR_ERR_INITFAILED) The first call to this function must initialise an underlying
+       system notification mechanism. On failure, this error is returned and errno
+       will have the system error status set.  If this function fails to intialise,
+       the poll mechansim, it is likely that message receives will never be successful.
+
 &space
 &di(RMR_ERR_TIMEOUT) The timeout expired before a complete message was received.
        All other fields in the message buffer are not valid.