Server connection description files

The library supports an option to load a simple text file with connection description information in it in order to configure the RSTP client or server. This page provides an example server configuration and explains how to use this feature. Note that the file is just a list of directives grouped into blocks saved as ASCII text.

An Example

Comment {
This is a sample RSTP configuration file. Everything is case sensitive. 
Whitespace is ignored. Otherwise, it's self-explanatory.
}

Server {
  Listen 0.0.0.0
  Port 10001
  Backlog 10
  MaxClients 2

  PassStream ALL
  FilterStream FLT /etc/radar/filterfile.txt
  PipeThrough FLT /etc/radar/pipeflt.sh
  
  Auth {
    testlogin  testpass { ALL }
    testlogin2 testpass2 { JUNK }
  }
  LoadAuthFile /etc/radar/authfile.txt { ALL FLT }
  
  Logging rstpserver /var/log/rstpserver.log 3
  StatusFile /var/log/rstpstatus.txt
}
   

Directive Descriptions

All directives are case sensitive!

• Server ............ Block. All server configuration directives are inside this block.
• Listen ............ Specify the IP address to listen on. Consider 0.0.0.0 (all interfaces).
• Port .............. Specify the TCP port to listen on. Usually 10001.
• Backlog ........... The TCP max backlog. Try 10 if unfamiliar with TCP.
• MaxClients ........ The maximum number of client connections to allow at one time.
• Auth .............. Block. Include login/password pairs, separated by spaces, followed by a list of authorized stream names in curly brackets.
• LoadAuthFile ...... Similar to an Auth line except load the login/password pairs from a separate file.
• PassStream ........ Declare an unfiltered data stream which will include all data made available to the server.
• FilterStream ...... Declare a filtered data stream. Data sent to the stream must match a filter. The filter file name is passed as the second argument to the directive. See libradar_stp::Filter for filter file documentation.
• PipeThrough ....... Arguments: stream_name executable_name. Directive to pipe all data on stream stream_name through the executable executable_name.
• SetStreamCache .... Arguments: stream_name cache_size filter_file. Enables caching of cache_size messages of each product on stream_name which matches the filter filter_file. See libradar_stp::Filter for filter file documentation.
• BroadcastFile ..... Periodically read and process the data in this file as received data. Use with BroadcastInterval
• BroadcastInterval . Set the broadcast file processing period to this number of seconds. Use with BroadcastFile.
• Logging ........... Arguments: progid, log_file, level. Keep a server log in log_file. Identify self with name progid. level is the logging level, recommend 3.
• StatusFile ........ Write server status information to this file.

See also:

libradar_stp::Filter for filter file documentation.

Discussion

The only mandatory elements of the Server block are Listen, Port, and at least one stream definition. The simplest stream definition is a PassStream. Most users will also want to use the authentication feature. It is important to note that authentication credentials are stored in clear text and are transmitted in clear text over the communication channel, so sensitive passwords are not appropriate for this use.

It is especially important to note that everything in a connection description file is case sensitive. The library uses a very simple parsing scheme, so format your files correctly!

---