X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Frmr_wh_open.3.rst;fp=docs%2Frmr_wh_open.3.rst;h=d3a913435316b63561ff26c585cdc980f40f9891;hb=0ccfca870ea9f7bdaba1ee3a02822051fea6cabd;hp=79cabddd0dd3dfff0f8944cd6535a92d2be92024;hpb=56a5312c71837e727379f627900fc22e46637a6b;p=ric-plt%2Flib%2Frmr.git diff --git a/docs/rmr_wh_open.3.rst b/docs/rmr_wh_open.3.rst index 79cabdd..d3a9134 100644 --- a/docs/rmr_wh_open.3.rst +++ b/docs/rmr_wh_open.3.rst @@ -30,7 +30,7 @@ SYNOPSIS #include - void* rmr_wh_open( void* vctx, char* target ) + rmr_whid_t rmr_wh_open( void* vctx, char* target ) @@ -44,10 +44,11 @@ established overtly by the user application (via this 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