test/rtg_sim/README

   1 #
   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 #
  19
  20 The rtm_sim is an extremely simple application which reads a configuration
  21 file, builds one or more route tables, and sends the table(s) to the
  22 indicated applications.  The applications are assumed to be RMr based
  23 applications which are listening either on a well known port (4561) for
  24 table updates, or on a port which is indicated in the config file.
  25
  26 The sim is _not_ intended to be a complete replacement for any route
  27 table mangager, but simply allows the ability to:
  28
  29         1) ensure that the RMr based application can receive real-time
  30            table updates (thus is configured correctly with the needed
  31            port properly exposed via the container environment if
  32            applicable).
  33
  34         2) allow the generation of one or more route tables from a central
  35            point during testing without having to run a more complicated
  36            route manager for basic testing.