Fix sonar flagged bugs

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

diff --git a/docs/overview.rst b/docs/overview.rst
index 91f7376..f4454be 100644 (file)
--- a/docs/overview.rst
+++ b/docs/overview.rst
@@ -12,24 +12,24 @@ RMR Overview
 ============================================================================================ 
  
  
 ============================================================================================ 
  
  

-RMr Library 
+RMR Library 

 ============================================================================================ 
  
  
 NAME 
 -------------------------------------------------------------------------------------------- 
  
 ============================================================================================ 
  
  
 NAME 
 -------------------------------------------------------------------------------------------- 
  

-RMr -- Ric Message Router Library 
+RMR -- Ric Message Router Library 

  
 DESCRIPTION 
 -------------------------------------------------------------------------------------------- 
  
  
 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 
 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 
 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 


@@ -39,7 +39,7 @@ application is unaware of which endpoint actually receives
 the message, and in some cases whether that message was sent 
 to multiple applications. 
  
 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. 
  
 specific source instance of a message allowing for either a 
 request response, or call response relationship when needed. 
  


@@ -47,16 +47,48 @@ The Route Table
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
  
 The library must be given a route table which maps message 
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
  
 The library must be given a route table which maps message 

-numbers to endpoint groups such that each time a message of 
-type T is sent, the message is delivered to one member of 
-each group associated with T. For example, message type 2 
-might route to two different groups where group A consists of 
-worker1 and worker2, while group B consists only of logger1. 
+types (integers) to endpoint groups such that each time a 
+message of type T is sent, the message is delivered to one 
+member of each group associated with T. For example, message 
+type 2 might route to two different groups where group A has 
+two members, worker1 and worker2, while group B has only one 
+member, logger1. 
+ 
+The route table consists of a start record, one or more table 
+entry records, and an end record. All table records contain 
+fields separated with vertical bars (|), and allow for 
+trailing comments with the standard shell comment symbol 
+(hash, #) provided that the start of the comment is separated 
+from the last token on the record by one or more spaces. 
+Leading and trailing white space in each field is ignored. 
+The route table supports two entry types: *rte* and *mse*. 
+ 
+A *rte* entry defines a message type, an optional sender 
+application, and the endpoint(s) which accept the indicated 
+message type. However, this format is deprecated and may be 
+removed in a future version. An example record appears next. 
+ 
+:: 
+  
+     rte | 1 | app10:4560
+ 
+ 
+ 
+The second type of entry is *mse*. This entry defines a 
+message type, an optional sender application, a subscription 
+ID, and a collection of endpoints. An example record appears 
+next. 
+ 
+:: 
+  
+     mse | 1000,forwarder:43086 | 10 | app2:43086
+ 
+ 

  
 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 
  
 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 
 for mapping messages to end points. 
  
 The following is a simple route table which causes message 


@@ -119,14 +151,15 @@ might look:
 Route Table Syntax 
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
  
 Route Table Syntax 
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
  

-The following illustrates the syntax for both the route 
-table. 
+The following illustrates the syntax for both types of route 
+table entries. 

  
  
 :: 
   
  newrt | start
  
  
 :: 
   
  newrt | start

- mse | <message-type>[,<sender-endpoint>] | <sub-id> <roud-robin-grp>[;<round-robin-grp>]...
+ rte | <message-type>[,<sender-endpoint>] | <round-robin-grp>[;<round-robin-grp>]...
+ mse | <message-type>[,<sender-endpoint>] | <sub-id> | <round-robin-grp>[;<round-robin-grp>]...

  newrt | end
  
  
  newrt | end
  
  


@@ -134,10 +167,10 @@ table.
 A round robin group is one or more endpoints from which one 
 will be selected to receive the message. When multiple 
 endpoints are given in a group, they must be separated with a 
 A round robin group is one or more endpoints from which one 
 will be selected to receive the message. When multiple 
 endpoints are given in a group, they must be separated with a 

-comma. An endpoint is the IP address and port (e.g. 
-192.158.4.30:8219) or DNS name and port of the application 
+comma. An endpoint is an IP address and port (e.g. 
+192.158.4.30:8219), or DNS name and port, of the application 

 that should receive the message type. If multiple round-robin 
 that should receive the message type. If multiple round-robin 

-groups are given, they must be separated by a semicolon, and 
+groups are given, they must be separated by a semicolon. 

  
 MEID Map Syntax 
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
  
 MEID Map Syntax 
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 


@@ -176,10 +209,10 @@ Environment
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
  
 To enable configuration of the library behaviour outside of 
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
  
 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 
 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. 
  
  
 if undefined.