Man page changes commited earlier were not published. This change
publishes these changes.
Signed-off-by: E. Scott Daniels <daniels@research.att.com>
Change-Id: I056d7f03e05b3fcc633ac6c12962b7ffc4a49aab
- void rmr_close( void* vctx, rmr_whid_t whid )
+ void rmr_wh_close( void* vctx, rmr_whid_t whid )
- void* rmr_wh_open( void* vctx, char* target )
+ rmr_whid_t rmr_wh_open( void* vctx, char* target )
function), and that the ID returned by ``rmr_wh_open`` be
passed to the ``rmr_wh_send_msg`` function.
function), and that the ID returned by ``rmr_wh_open`` be
passed to the ``rmr_wh_send_msg`` function.
-*Target* is the *name* or *IP-address* combination of the
-processes that the wormhole should be connected to. *Vctx* is
-the RMR void context pointer that was returned by the
-``rmr_init`` function.
+*Vctx* is the RMR void context pointer that was returned by
+the ``rmr_init`` function. *Target* is the *name and port,*
+or *IP-address and port,* combination for the process that
+the wormhole should be connected to. For example,
+"localhost:6123".
When invoked, this function immediately attempts to connect
to the target process. If the connection cannot be
When invoked, this function immediately attempts to connect
to the target process. If the connection cannot be
- 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 )
caller may leave the message type unspecified in the message
buffer (unless it is needed by the receiving process).
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.