Add ability to save route table updates to disk

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

diff --git a/doc/src/man/rmr_mt_rcv.3.xfm b/doc/src/man/rmr_mt_rcv.3.xfm
index 25b418a..f5d073a 100644 (file)
--- a/doc/src/man/rmr_mt_rcv.3.xfm
+++ b/doc/src/man/rmr_mt_rcv.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.
@@ -44,7 +44,7 @@ rmr_mbuf_t* rmr_mt_rcv( void* vctx, rmr_mbuf_t* old_msg, int timeout );
 &h2(DESCRIPTION)
 The &cw(rmr_mt_rcv) function blocks until a message is received, or the timeout
 period (milliseconds) has passed.
-The result is an RMr message buffer which references a received message.
+The result is an RMR message buffer which references a received message.
 In the case of a timeout the state will be reflected in an "empty buffer" (if old_msg
 was not nil, or simply with the return of a nil pointer.
 If a timeout value of zero (0) is given, then the function will block until
@@ -79,7 +79,7 @@ mode with the same "pass through" overhead to using this function directly.
 
 &h2(RETURN VALUE)
 When a message is received before the timeout period expires, a pointer to the
-RMr message buffer which describes the message is returned.
+RMR message buffer which describes the message is returned.
 This will, with a high probability, be a different message buffer than &ital(old_msg;)
 the user application should not continue to use &ital(old_msg) after it is passed
 to this function.
@@ -94,24 +94,20 @@ values:
 &space
 
 &beg_dlist(.75i : ^&bold_font )
-&di(RMR_OK) The message was received without error.
+&ditem(RMR_OK) The message was received without error.
 
-&half_space
-&di(RMR_ERR_BADARG) A parameter passed to the function was not valid (e.g. a nil pointer).
+&ditem(RMR_ERR_BADARG) A parameter passed to the function was not valid (e.g. a nil pointer).
 
 indicate either &cw(RMR_OK) or
 &cw(RMR_ERR_EMPTY) if an empty message was received.
 
-&half_space
-&di(RMR_ERR_EMPTY) The message received had no associated data. The length of the
+&ditem(RMR_ERR_EMPTY) The message received had no associated data. The length of the
     message will be 0.
 
-&half_space
-&di(RMR_ERR_NOTSUPP) The multi-threaded option was not enabled when RMr was
+&ditem(RMR_ERR_NOTSUPP) The multi-threaded option was not enabled when RMR was
 initialised.  See the man page for &ital(rmr_init()) for details.
 
-&half_space
-&di(RMR_ERR_RCVFAILED) A hard error occurred preventing the receive from completing.
+&ditem(RMR_ERR_RCVFAILED) A hard error occurred preventing the receive from completing.
 &end_dlist
 
 
@@ -120,28 +116,21 @@ buffer,  &cw(errno) will be set to one of the following:
 &space
 
 &beg_dlist(.75i : ^&bold_font )
-&di(INVAL) Parameter(s) passed to the function were not valid.
+&ditem(INVAL) Parameter(s) passed to the function were not valid.
 
-&half_space
-&di(EBADF) The underlying message transport is unable to process the request.
+&ditem(EBADF) The underlying message transport is unable to process the request.
 
-&half_space
-&di(ENOTSUP) The underlying message transport is unable to process the request.
+&ditem(ENOTSUP) The underlying message transport is unable to process the request.
 
-&half_space
-&di(EFSM) The underlying message transport is unable to process the request.
+&ditem(EFSM) The underlying message transport is unable to process the request.
 
-&half_space
-&di(EAGAIN) The underlying message transport is unable to process the request.
+&ditem(EAGAIN) The underlying message transport is unable to process the request.
 
-&half_space
-&di(EINTR) The underlying message transport is unable to process the request.
+&ditem(EINTR) The underlying message transport is unable to process the request.
 
-&half_space
-&di(ETIMEDOUT) The underlying message transport is unable to process the request.
+&ditem(ETIMEDOUT) The underlying message transport is unable to process the request.
 
-&half_space
-&di(ETERM) The underlying message transport is unable to process the request.
+&ditem(ETERM) The underlying message transport is unable to process the request.
 &end_dlist
 
 &h2(EXAMPLE)