Client 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 client 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.
   }
 
   ClientGroup {
   
     RepeatCheck yes
     RepeatDBSize 100
     
     RedundantPeerMode no
     RPMMaxTicks 10
   
     Client {
       Stream INET
  
       Connection {
         Host kb9rlf.net
         Port 10001
         Timeout 1200
         Login your_login_here
         Pass your_password_here
       }
     }
   }
   

Directive Descriptions

All directives are case sensitive!

• ClientGroup ........ Block. Represents a collection of simultaneously maintained connections.
• RepeatCheck ........ Enable data repeat checking. Values: yes or no . (optional, default yes)
• RepeatDBSize ....... Adjust size of the repeat checking hash/signature database. (optional)
• RedundantPeerMode .. Enable Redundant Peer Mode. Values: yes or no . (optional, default no) Note: This is a very specialized feature. See the libradar_stp::RSTPClientMCIf class API documentation.
• RPMMaxTicks ........ Set the number of ticks required for deltas to be relayed in Redundant Peer Mode.
• Client ............. Block. Represents a collection of different connections, of which only one should be active at a time.
• Stream ............. Specify the name of a data stream to request. Multiple Stream directives are OK.
• Connection ......... Block. Represents parameters to make a TCP/IP connection to a server.
• Host ............... Specify the fully-qualified name or IP address of the host to connect to.
• Port ............... Specify the TCP port which the RSTP server is running on.
• Timeout ............ How many seconds of dead time to wait before trying next connection (optional, you may accept the default).
• Login .............. Login name, if server requires it. Case sensitive. (optional)
• Pass ............... Password, if server requires it. Case sensitive. (optional)

Discussion

You may include multiple Connection blocks within a Client block. In this case, if the first is detected to go down (depends on Timeout setting), then the client will attempt to connect to the server described in the second Connection block.

You may also include multiple Client blocks within a ClientGroup block. Each client block is treated as described above, except the client attempts to maintain one connection from each Client block. This is how you can configure the client to connect to multiple servers at one time. The RepeatCheck option allows you to enable data repeat checking, which should prevent multiple copies of received data from being passed to the data callback.

You may include both a Client or ClientGroup and a Server block in the same file. This is especially useful for configuring relay nodes.

Redundant Peer Mode is a specialized feature used to save bandwidth between peered nodes which each have their own independent data sources. See the RSTPClientMCIf class API documentation for more information on this mode.

Finally, 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!

---