RTgms Options


RTgms options can be set to specific values by defining them in the rtgms.cm command file. Option values that have been specified in the command file are set each time RTgms is started, or they can be modified using the setopt command in a CONTROL message. For general information on setting options, see Setting Option Values. For information on conventions used in specifying options, see Specifying Options. For information on the RTgms command file, see RTgms Startup Command Files.

Certain options can be modified dynamically for a particular RTgms connection using an ADMIN_SET message. When you send the message to a particular RTgms process, the options apply only to outbound data sent on the specified group channel connection.

The ADMIN_SET message used for setting bandwidth rate control options is:

T_MT_GRP_ADMIN_SET_OUTBOUND_RATE_PARAMS 
T_STR   group_name 
T_INT4  token_rate 
T_INT4  max_tokens 
T_REAL8 burst_interval 

where:

group_name
must be the multicast group name of the group channel, matching an existing group name specified by the Group_Names option.
token_rate
is the rate in bytes/second at which tokens accumulate. A value of -1 indicates no change. token_rate is equivalent to the Group_Token_Rate option.
max_tokens
is the maximum number of tokens that can accumulate. A value of -1 indicates no change. max_tokens is equivalent to the Group_Max_Tokens option.
burst_interval
is the burst interval in number of seconds. A value of -1.0 indicates no change. burst_interval is equivalent to the Group_Burst_Interval option.

The ADMIN_SET message used for setting PGM options is:

T_MT_GRP_ADMIN_SET_PGM_OPTIONS 
T_STR   group_name 
T_STR   option_name 
T_INT4  option_value 

where:

group_name
is the name of the multicast group for which you want these parameters set. It needs to match an existing group name specified by the Group_Names option. The options apply to the group channel used by Group_Names.
option_name
is the name of the PGM option you want to set. Currently, the only PGM option you can set in this way is Pgm_Source_Max_Trans_Rate. For option_name, the valid values are currently source_max_trans_rate and pgm_source_max_trans_rate.
option_value
is the value you are specifying for option_name. For Pgm_Source_Max_Trans_Rate, the valid values are any integers greater than 0 and the default value is 4000000.

RTgms Startup Command Files

The RTgms process has standard startup command files, called rtgms.cm. The RTgms startup command file contains generic information that RTgms needs to know, such as what values to use for IPC-related timeouts, connection names, maximum number of clients, and so on.

This example illustrates a typical RTgms startup command file:

setopt project ss_test 
setopt conn_names pgm:_node 
setopt server_names tcp:_node  
setopt group_threshold 10  
setopt group_names rtworks, group1, group2 

RTgms recognizes three levels of startup command files. When first invoked, it searches for and executes the commands in each file, in this order:

  1. the system-level rtgms.cm file in the SmartSockets standard directory
  2. RTgms searches for a system-level process command file rtgms.cm in the SmartSockets directory standard, in RTHOME:

    • UNIX: $RTHOME/standard
    • Windows: %RTHOME%\standard
    • To add or change RTgms options, change to this directory and use an editor to add or change the system-wide option settings.

  1. the user-level rtgms.cm file in the user’s home directory
  2. RTgms searches for an rtgms.cm file in the user’s home directory (specified by the HOME environment variable) and, if found, executes the commands in that file. This file is the ideal place to set options that you want set for all your projects. To create this file, use an editor to open a new file named rtgms.cm in your home directory:

    • UNIX: $HOME
    • Windows: %HOME%
    • and use the editor to add the options you choose.

  3. the file specified by the -command argument, or the local-level rtgms.cm file in the current directory (if the -command argument is not specified)
  4. RTgms reads and executes the rtgms.cm file found in the current directory, that is, the directory from which RTgms is being run. In this file, place any project-specific option declarations, such as the name of the project and where to find RTserver. The local command file is read last to allow you to override any initial values that might have been set for the RTgms options.


TIBCO SmartSockets™ User’s Guide
Software Release 6.8, July 2006
Copyright © TIBCO Software Inc. All rights reserved
www.tibco.com