X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=doc%2Fsrc%2Fman%2Frmr_torcv_msg.3.xfm;h=d160f53e47bfa228e8ca7be834359dfb2b5d45d4;hb=3d7285ec4c96724b64968f46c2075b77e8d08543;hp=0482419c5cb85c1b0af69699c13ffbf84e7ce25b;hpb=fd9cc7a5b3355146388ebdf4d558cb284c66c5f1;p=ric-plt%2Flib%2Frmr.git diff --git a/doc/src/man/rmr_torcv_msg.3.xfm b/doc/src/man/rmr_torcv_msg.3.xfm index 0482419..d160f53 100644 --- a/doc/src/man/rmr_torcv_msg.3.xfm +++ b/doc/src/man/rmr_torcv_msg.3.xfm @@ -23,19 +23,8 @@ Date 29 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) @@ -83,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. @@ -140,6 +135,3 @@ rmr_mk_ring(3), rmr_ring_free(3) .ju on - -.qu -