Document both valid route table entry types

[ric-plt/lib/rmr.git] / docs / overview.rst

diff --git a/docs/overview.rst b/docs/overview.rst
index 8168b9f..4997001 100755 (executable)
--- a/docs/overview.rst
+++ b/docs/overview.rst
@@ -1,4 +1,5 @@
  
+ 
 .. This work is licensed under a Creative Commons Attribution 4.0 International License. 
 .. SPDX-License-Identifier: CC-BY-4.0 
 .. CAUTION: this document is generated from source in doc/src/rtd. 
@@ -6,28 +7,29 @@
 .. Do NOT make changes directly to .rst or .md files. 
  
  
+ 
 RMR Overview 
 ============================================================================================ 
  
  
-RMr Library 
+RMR Library 
 ============================================================================================ 
  
  
 NAME 
 -------------------------------------------------------------------------------------------- 
  
-RMr -- Ric Message Router Library 
+RMR -- Ric Message Router Library 
  
 DESCRIPTION 
 -------------------------------------------------------------------------------------------- 
  
-RMr is a library which provides a user application with the 
-ability to send and receive messages to/from other RMr based 
+RMR is a library which provides a user application with the 
+ability to send and receive messages to/from other RMR based 
 applications without having to understand the underlying 
 messaging transport environment (e.g., SI95) and without 
 needing to know which other endpoint applications are 
-currently available and accepting messages. To do this, RMr 
+currently available and accepting messages. To do this, RMR 
 depends on a routing table generated by an external source. 
 This table is used to determine the destination endpoint of 
 each message sent by mapping the message type T (supplied by 
@@ -37,12 +39,12 @@ application is unaware of which endpoint actually receives
 the message, and in some cases whether that message was sent 
 to multiple applications. 
  
-RMr functions do provide for the ability to respond to the 
+RMR functions do provide for the ability to respond to the 
 specific source instance of a message allowing for either a 
 request response, or call response relationship when needed. 
  
 The Route Table 
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
  
 The library must be given a route table which maps message 
 numbers to endpoint groups such that each time a message of 
@@ -54,7 +56,7 @@ worker1 and worker2, while group B consists only of logger1.
 It is the responsibility of the route table generator to know 
 which endpoints belong to which groups, and which groups 
 accept which message types. Once understood, the route table 
-generator publishes a table that is ingested by RMr and used 
+generator publishes a table that is ingested by RMR and used 
 for mapping messages to end points. 
  
 The following is a simple route table which causes message 
@@ -115,7 +117,7 @@ might look:
  
  
 Route Table Syntax 
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
  
 The following illustrates the syntax for both the route 
 table. 
@@ -124,7 +126,7 @@ table.
 :: 
   
  newrt | start
- mse | <message-type>[,<sender-endpoint>] | <sub-id> <roud-robin-grp>[;<round-robin-grp>]...
+ mse | <message-type>[,<sender-endpoint>] | <sub-id> | <round-robin-grp>[;<round-robin-grp>]...
  newrt | end
  
  
@@ -138,7 +140,7 @@ that should receive the message type. If multiple round-robin
 groups are given, they must be separated by a semicolon, and 
  
 MEID Map Syntax 
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
  
 The MEID map is similar to the route table. Entries are used 
 to add or replace the ownership of one or more MEIDs (mme_ar) 
@@ -171,13 +173,13 @@ that all data was received exactly as the route manager
 transmitted them. 
  
 Environment 
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
  
 To enable configuration of the library behaviour outside of 
-direct user application control, RMr supports a number of 
+direct user application control, RMR supports a number of 
 environment variables which provide information to the 
 library. The following is a list of the various environment 
-variables, what they control and the defaults which RMr uses 
+variables, what they control and the defaults which RMR uses 
 if undefined.