GoServe: CONTROL command

CONTROL command

Syntax:

  CONTROL [VAR varname] options

A GoServe control action (such as moving the audit file, resetting counters, or requesting statistics) is initiated, and a result string is either placed in a Rexx variable or returned to the client.

This is used for controlling the GoServe server from the filter, either directly or on request from a remote client or from another process on the same machine -- for information on ways to do this, see "Remote control of GoServe".

The possible options are:

MOVEAUDIT
The audit file is copied to the archive file (just as though the 'Move audit to archive' Actions menu item had been selected).
RESET [BYTES] [PEAK] [RESPONSE] [TRANSACTIONS] [LIMITS] [ERRORS] [ALL]
The specified GoServe counters and statistics are reset (after auditing, if appropriate). Any or all of the keywords may be given, in any order. Each works in the same way as the corresponding Actions menu item; RESPONSE refers to the response time record.
If ALL is used, all of the items are reset, and a record of the time is kept; this time will be shown on the display window and in any statistics requests.
SAY string
The given string is returned; this can be used as a simple 'Loopback test'.
STATISTICS
Current statistics and settings are returned. These include:
1. Transaction, error, limits, byte, and client counts, with response time averages
2. Certain settings and options (not including audit selections)
3. The local time of certain events (if an event has not occurred, it is shown as the GoServe start time).

The result of a CONTROL command is a single string, which may include multiple lines, separated by Carriage Return-Line Feed (CR-LF, ASCII '0d0a'x) sequences. The exact format is not defined. The result string is either placed in a variable or returned to the client:

If 'VAR varname' was specified, the result string is placed in the named Rexx variable. The name of the variable is used just as if it appeared in the filter program (for example, the name 'local.j' might have the value of J substituted in the name).
If 'VAR' was not specified, a document containing the string is returned to the client (just as though the STRING command were used), so in this case, CONTROL is a 'completion command'.

[ previous section | GoServe | next section ]