X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Frmr_wh_send_msg.3.rst;h=7de91a8baef1dfa27416bc8fa1fcaa6379c1867b;hb=refs%2Ftags%2F4.1.3;hp=8e9a9c282eeeda97fec132c88b981e4ec17585a8;hpb=a3a121ca4a0426ec964fa684fb27c397f2ee9e24;p=ric-plt%2Flib%2Frmr.git diff --git a/docs/rmr_wh_send_msg.3.rst b/docs/rmr_wh_send_msg.3.rst index 8e9a9c2..7de91a8 100644 --- a/docs/rmr_wh_send_msg.3.rst +++ b/docs/rmr_wh_send_msg.3.rst @@ -30,7 +30,7 @@ SYNOPSIS #include - rmr_mbuf_t* rmr_wh_send_msg( void* vctx, rmr_whid_t id, rmr_mbuf_t* msg ); + rmr_mbuf_t* rmr_wh_send_msg( void* vctx, rmr_whid_t id, rmr_mbuf_t* msg ) @@ -47,10 +47,12 @@ normal RMR routing based on message type is ignored, and the caller may leave the message type unspecified in the message buffer (unless it is needed by the receiving process). -The message buffer (msg) used to send is the same format as -used for regular RMR send and reply to sender operations, -thus any buffer allocated by these means, or calls to -*rmr_rcv_msg()* can be passed to this function. +*Vctx* is the RMR void context pointer that was returned by +the ``rmr_init`` function. The message buffer (msg) used to +send is the same format as used for regular RMR send and +reply to sender operations, thus any buffer allocated by +these means, or calls to *rmr_rcv_msg()* can be passed to +this function. Retries @@ -60,11 +62,11 @@ The send operations in RMR will retry *soft* send failures until one of three conditions occurs: - &item The message is sent without error +* The message is sent without error - &item The underlying transport reports a *hard* failure +* The underlying transport reports a *hard* failure - &item The maximum number of retry loops has been attempted +* The maximum number of retry loops has been attempted A retry loop consists of approximately 1000 send attempts