X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fconfig-deploy.rst;h=a7b77b818ad41dc8b3b0087b2540451ea81dc9c9;hb=fe6a856df463a0d7e06b28aac8590ac9c0f08dd6;hp=1726fb8129aac1d6d51e44f6ff8f9324fb29aa4b;hpb=d961525e9eb23e3dee4a16960a1772782c3b8b36;p=ric-plt%2Flib%2Frmr.git diff --git a/docs/config-deploy.rst b/docs/config-deploy.rst index 1726fb8..a7b77b8 100644 --- a/docs/config-deploy.rst +++ b/docs/config-deploy.rst @@ -6,29 +6,32 @@ .. Do NOT make changes directly to .rst or .md files. -RMR Configuration and Delpoyment +RMR Configuration and Deployment ============================================================================================ -The RIC Message Router (RMR) is a library which applications -use to send and receive messages where the message routing, -endpoint selection, is based on the message type rather than -on traditional DNS names or IP addresses. This document -contains information regarding the configuration of RMR when -it is embedded by a *user application* . RMR itself is not a -deployable entity. +The RIC Message Router (RMR) is a library for peer-to-peer +communication. Applications use the library to send and +receive messages where the message routing and endpoint +selection is based on the message type rather than DNS host +name-IP port combinations. + +This document contains information regarding the +configuration of RMR when it is embedded by a *user +application* . RMR itself is a library, not a deployable +entity. Configuration -------------------------------------------------------------------------------------------- -Several aspects of RMR behaviour is controlled via -environment variables which are set at the time that a user -application invokes the RMR initialisation function. This -allows these variables to be set before the application is -started as a function of the true environment, or set by the -application as a means for the application to influence RMR's -behaviour. The following is a list of RMR variables which RMR -recognises (see the main RMR manual page in the development -package for more details). +Many aspects of RMR behavior are controlled via environment +variables. These values are read when a user application +invokes the RMR initialization function. This allows these +variables to be set before the application is started as a +function of the true environment, or set by the application +as a means for the application to influence RMR's behaviour. +The following is a list of environment variables which RMR +recognizes. Also see the main RMR manual page in the +development package for more details. RMR_ASYNC_CONN