rtserver


Name

rtserver — start or stop the RTserver process

Synopsis

rtserver [-check] [ -command filename] [ -help ] [ -install ]  
         [ -license ] [-no_console] [ -no_daemon ]  
         [ -password pword] [ -reconfigure pid ] 
         [ -server_names names_list]  [ -stop ] 
         [ -stop_all ] [ -stop_clients ] [ -stop_servers ]  
         [ -threads n ] [ -trace_file filename ]  
         [ -trace_level level ]  [ -uninstall ] [ -username name] 
         [ -verbose ] [ -version ] 

Arguments

-check — start the non-optimized version of the RTserver

-command filename — specify the startup command file for the RTserver

-help — print a summary of the arguments for the rtserver command to the console

-install — install the RTserver as a Windows service. Use -demandstart or -autostart with this argument to specify the startup mode of the service. This option is supported only on Windows systems.

-license — display license information about your RTserver

-no_console — do not display a Windows console associated with the detached process

-no_daemon — run the RTserver as a foreground process

-password pword — specify a password to use when connecting to RTservers with Basic Security enabled

-reconfigure pid — instruct RTserver to re-read its .cm files by sending SIGHUP to the specified RTserver process. (Supported on UNIX platforms only.)

-server_names names_list — specify a list of server names for the Server_Names option

-stop — stop one RTserver

-stop_all — stop all RTserver processes and all RTclient processes

-stop_clients — stop one RTserver and all of its RTclient processes

-stop_servers — stop all RTserver processes

-threads n — start the RTserver in MP multithread mode

-trace_file filename — specify the name of the file where the RTserver writes debugging information

-trace_level level — specify the amount of information the RTserver writes to the debug file

-uninstall — remove the RTserver as a Windows service. This option is supported only on Windows systems.

-username name — specify a username to use when connecting to RTservers with Basic Security enabled

-verbose — is the same as using -trace_level verbose_1

-version — print version and revision levels of the RTserver to the console

Return Values

On UNIX and Windows, rtserver returns 0 if successful, and a non-zero value otherwise. On OpenVMS, rtserver returns an odd (usually but not always 1) value if successful, and an even value otherwise.

Description

The rtserver script starts an RTserver. For a complete description of RTserver, see the TIBCO SmartSockets User’s Guide. RTserver by default runs until initialization is complete, then starts a background process to continue. (On OpenVMS and Windows, this is known as a detached process.) The parent process then exits.

The rtserver script runs the RTserver executable. On UNIX, rtserver is a symbolic link to the generic SmartSockets startup script, rtprocess. On OpenVMS, rtserver is not a script, but rather a symbol.

When started, RTserver looks for the license startup command file. This file contains settings for license-related options used by RTserver to obtain a license during the startup process.

The arguments for rtserver are:

-check 
starts the non-optimized version of RTserver, which performs additional validations and checking. If you do not specify -check, by default the optimized version of RTserver is started. The optimized version is faster because validation and checking is turned off. However, without the validation and checking, it is harder to debug any problems. When developing your applications or testing RTserver in your development or production environments, always start RTserver with the -check argument.
-command filename 
causes RTserver to look for a file named filename in the current directory (the directory from which RTserver is being run) and use that as a startup command file. Values for options specified in that file override values for the same options specified in the system-level or user-level startup command file.
-help 
causes RTserver to print a brief summary of the arguments for the rtserver script and exit.
-install -demandstart 
         -autostart 
installs the RTserver process as a Windows service. You can specify -demandstart or -autostart as the startup mode of the service. This option is supported only on Windows systems.
-license 
displays license information about your RTserver. This is useful for finding out your license number when you need to contact TIBCO Product Support. Or you can display license information by using the rtlic shell script. See page 327 for more information.
-no_console 
specifies not to display a Windows console associated with the detached process. Because there is no Windows console, to save output from the RTserver in this mode, you must set the Trace_File option or the -trace_file argument. This argument is ignored if you specify -no_daemon.
-no_daemon 
specifies not to start RTserver as a background process and instead run in the foreground.
-node node_name 
starts RTserver on a remote node. A remote shell command is used with rsh (remsh on HP-UX) to start RTserver on the remote node.
-password pword
provides the password used by RTserver, along with a username, to connect to other RTservers when Basic Security is enabled. Use with the -username argument.
pword size is unlimited. To specify no password, use empty quotation marks ("")
-reconfigure pid

Instructs RTserver to re-read its .cm files by sending SIGHUP to the specified RTserver process. (Supported on UNIX platforms only.)

-server_names names_list 
specifies the value or values to use for the option Server_Names. names_list is a list of logical connection names separated by commas. It allows you to override the value or values specified in a startup command file. The values you specify here must use the same syntax as any value set for the Server_Names option.
-stop  
specifies that a single RTserver should be stopped. The RTclients that are connected to that RTserver continue to run, eventually detect that RTserver has stopped, and try to find or start a new RTserver.
-stop_all 
specifies that one RTserver, all RTservers connected to that RTserver, and all RTclients connected to all of the above RTservers should all be stopped. The RTclients are stopped by sending them a CONTROL message with a destination subject of _all and containing the command quit force.
-stop_clients 
specifies that one RTserver and all RTclients connected to that RTserver should be stopped. The RTclients are stopped by sending them a CONTROL message with a destination subject of _all and containing the command quit force.
-stop_servers 
specifies that one RTserver as well as all RTservers connected to that RTserver should be stopped. The RTclients that are connected to those RTservers continue to run, eventually detect that RTserver has stopped, and try to find or start a new RTserver.
-threads n 
specifies whether the RTserver should start in MP multithread mode, and the number of threads to use. If you do not specify this argument, the default is 1 and RTserver starts in normal mode. If you specify a value greater than 1, the process checks to see if this RTserver was licensed for the MP option. If yes, the RTserver is started in multi-thread mode with the number of threads you specified for n. If no, you receive a warning message and the RTserver is started in single-thread mode.
We do not recommend setting n to a large number. See the TIBCO SmartSockets User’s Guide for more information.
The value you specify for -threads overrides the value specified for the Server_Num_Threads option in any of the RTserver startup command files.
-trace_file filename 
specifies the name of the file where the RTserver puts debug information. The default, if you do not specify this argument, is the standard output (stdout) which is printed to the console.
You can change the value of -trace_file after RTserver is started by issuing a CONTROL message to override the values specified at startup time.
-trace_level level 
specifies the amount of information the RTserver puts in the debug file (the file you specified in -trace_file). You can change the value of -trace_level after RTserver is started by issuing a CONTROL message to override the values specified at startup time.
These are the values you can specify for level:
  • never, no information is put in a debug file
  • error, only error messages put in debug file
  • warning, error and warning messages are put in debug file. This is the default setting.
  • info
  • info_1, provides thread information for multi-threading
  • info_2
  • verbose
  • verbose_1
  • verbose_2
  • debug, provides the maximum amount of information
-uninstall 
removes RTserver as a Windows service. This option is only supported on Windows systems.
-username name
provides the username used by RTserver, along with a password, to connect to other RTservers when Basic Security is enabled. Use with the -password argument.
name size is restricted to 64 characters.
-verbose 
is the same as specifying -trace_level info. The -verbose argument is provided for backwards compatibility. The preferred method for specifying the amount of information for RTserver to provide is to use the -trace_level argument.
-version 
causes RTserver to print version and revision levels.

The -stop arguments have precedence over all other command-line arguments. For example, if both -node and -stop are specified on the command line, only -stop is used. The Enable_Stop_Msgs option in the startup command file specifies whether or not RTserver can be stopped with rtserver -stop. By default this option is set to TRUE, allowing you and all users to stop RTserver. When it is disabled, no variation of the rtserver -stop command is permitted (including rtserver -stop_all). Security-conscious sites should set this option to FALSE to prevent accidental shutdown of an entire SmartSockets system.

You can change the value of the Enable_Stop_Msgs option after RTserver is started by issuing a CONTROL message. The new value overrides the value specified at startup.

Caution

To start RTserver on a remote node, use the command rtserver -node remote_node instead of executing rtserver with a remote shell command such as rsh remote_node rtserver (remsh remote_node rtserver on HP-UX), otherwise your local shell hangs until the remote RTserver exits.

To use a space, tab, comma, or semicolon in the -server_names name list, double quotes must be included in the name list, as shown in these examples:

UNIX:
-server_names ’"local:_node:two words"’ 
OpenVMS:
-server_names """local:_node:two words""" 
Windows:
-server_names "local:_node:two words" 

See Also

None

Examples

To start an RTserver using the default values of the arguments, enter:

rtserver 

On UNIX systems, you should see SmartSockets banner information and then a line saying that RTserver started successfully.

On Windows systems, if RTserver started successfully, the window is automatically minimized. Check your bottom bar for the RTserver process and click on it to expand the window. In the window, you should see a message saying that the RTserver was started successfully.

The next example shows the output from rtserver when run with the -stop command-line argument:

$ rtserver -stop 
 
SmartSockets banner information 
. 
. 
. 
Connecting to project <rtworks> on <_node> RTserver. 
Using local protocol. 
Connecting to project <rtworks> on <_node> RTserver. 
Using local protocol. 
Message from RTserver: Connection established. 
Start subscribing to subject </_workstation1_13597>. 
Sending RTserver stop message. 
Message from RTserver: RTserver stopping. 

If RTserver is not running when rtserver -stop is executed, this output appears:

$ rtserver -stop 
 
SmartSockets banner information 
. 
. 
. 
TAL-SS-00088-I Connecting to project <rtworks> on <_node> RTserver 
TAL-SS-00089-I Using tcp protocol 
TAL-SS-00090-I Could not connect to <_node> RTserver 
TAL-SS-00093-I Skipping starting <_node> RTserver 
TAL-SS-50001-I RTserver is not currently running. 

This example shows how to use the rtserver command to stop an RTserver on node mynode that is using a custom TCP/IP port number:

$ rtserver -stop -server_names tcp:mynode:2001 

TIBCO SmartSockets™ Utilities
Software Release 6.8, July 2006
Copyright © TIBCO Software Inc. All rights reserved
www.tibco.com