doc/src/man/rmr.7.xfm

   1 .if false
   2 ==================================================================================
   3         Copyright (c) 2019 Nokia
   4         Copyright (c) 2018-2019 AT&T Intellectual Property.
   5
   6    Licensed under the Apache License, Version 2.0 (the "License");
   7    you may not use this file except in compliance with the License.
   8    You may obtain a copy of the License at
   9
  10        http://www.apache.org/licenses/LICENSE-2.0
  11
  12    Unless required by applicable law or agreed to in writing, software
  13    distributed under the License is distributed on an "AS IS" BASIS,
  14    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15    See the License for the specific language governing permissions and
  16    limitations under the License.
  17 ==================================================================================
  18 .fi
  19 .if false
  20         Mnemonic        rmr.7.xfm
  21         Abstract        The manual page for the whole RMr library
  22         Author          E. Scott Daniels
  23         Date            29 January 2019
  24 .fi
  25
  26 .gv e LIB lib
  27 .im &{lib}/man/setup.im
  28
  29 &line_len(6i)
  30
  31 &h1(RMr Library)
  32 &h2(NAME)
  33         RMr -- Ric Message Router Library
  34
  35 &h2(DESCRIPTION)
  36 RMr is a library which provides  a user application with the ability
  37 to send and receive messages to/from  other RMr based applications
  38 without having to understand the underlying messaging transport environment (e.g. Nanomsg)
  39 and without needing to know which other endpoint applications are currently
  40 available and accepting messages.
  41 To do this, RMr depends on a routing table generated by an external source.
  42 This table is used to determine the destination endpoint of each message sent by mapping the
  43 message type T (supplied by the user application) to an endpoint entry.
  44 Once determined, the message is sent directly to the endpoint.
  45 The user application is unaware of which endpoint actually receives the
  46 message, and in some cases whether that message was sent to multiple
  47 applications.
  48
  49 &space
  50 RMr functions do provide for the ability to respond to the specific source
  51 instance of a message allowing for either a request response, or call
  52 response relationship when needed.
  53
  54
  55 &h3(The Route Table)
  56 The library is supplied with a route table which maps message numbers to
  57 endpoint groups such that each time a message of type T is sent, the message
  58 is delivered to one member of each group associated with T.
  59 For example, message type 2 might route to two different groups where
  60 group A consists of worker1 and worker2, while group B consists only of
  61 logger1.
  62
  63 &space
  64 It is the responsibility of the route table generator to know which endpoints
  65 belong to which groups, and which groups accept which message types.
  66 Once understood, the route table generator publishes a table that is ingested
  67 by RMr and used for mapping messages to end points.
  68
  69 &h3(Environment)
  70 To enable configuration of the library behaviour outside of direct user application
  71 control, RMr supports a number of environment variables which provide information
  72 to the library.
  73 The following is a list of the various environment variables, what they control
  74 and the defaults which RMr uses if undefined.
  75
  76 &beg_dlist(.75i : ^&bold_font )
  77 &di(RMR_BIND_IF) This provides the interface that RMr will bind listen ports to allowing
  78         for a single interface to be used rather than listening across all interfaces.
  79         This should be the IP address assigned to the interface that RMr should listen
  80         on, and if not defined RMr will listen on all interfaces.
  81
  82 &di(RMR_RTG_SVC) RMr opens a TCP listen socket using the port defined by this
  83         environment variable and expects that the route table generator process
  84         will connect to this port.
  85         If not supplied the port 4561 is used.
  86
  87 &di(RMR_RTG_ISRAW) Is set to 1 if the route table generator is sending "plain" messages
  88         (not using RMr to send messages, 0 if the rtg is using RMr to send. The default
  89         is 1 as we don't expect the rtg to use RMr.
  90
  91 &di(RMR_SEED_RT) This is used to supply a static route table which can be used for
  92         debugging, testing, or if no route table generator process is being used to
  93         supply the route table.
  94         If not defined, no static table is used and RMr will not report &ital(ready)
  95         until a table is received.
  96 &end_dlist
  97
  98
  99 &h2(SEE ALSO )
 100 .ju off
 101 rmr_alloc_msg(3),
 102 rmr_tralloc_msg(3),
 103 rmr_call(3),
 104 rmr_free_msg(3),
 105 rmr_init(3),
 106 rmr_init_trace(3),
 107 rmr_get_meid(3),
 108 rmr_get_src(3),
 109 rmr_get_srcip(3),
 110 rmr_get_trace(3),
 111 rmr_get_trlen(3),
 112 rmr_get_xact(3),
 113 rmr_payload_size(3),
 114 rmr_rcv_msg(3),
 115 rmr_rcv_specific(3),
 116 rmr_rts_msg(3),
 117 rmr_ready(3),
 118 rmr_fib(3),
 119 rmr_has_str(3),
 120 rmr_tokenise(3),
 121 rmr_mk_ring(3),
 122 rmr_ring_free(3),
 123 rmr_set_trace(3),
 124 rmr_torcv_msg(3),
 125 rmr_wh_open(3),
 126 rmr_wh_send_msg(3)
 127 .ju on
 128
 129
 130 .qu