Filter commands


Commands may be executed by GoServe filters at any time, using the usual Rexx command syntax (a clause that is just an expression). In addition, any string returned by the filter will be executed as a command.

Certain commands (CLOSE, CONTROL, FILE, NODATA, STRING, and VAR) can be 'completion commands'; that is, after executing the command, the response to the client will have been sent and will be complete. Only one completion command may be executed for each request received; once a completion command has been executed, no further commands will be accepted.

If the filter ends without error and without executing or returning any completion command, the server will generate one (currently "String [No information available]").

Errors and failures in commands are reported by a non-zero return code (which is placed in the Rexx variable RC), and also may raise the ERROR or FAILURE condition if enabled by SIGNAL ON or CALL ON in the filter. Command errors are also audited unless Error auditing has been turned off. For details on the possible return codes, see "Command return codes".

The total length of a command is limited to 1000 characters.

The most important commands are the completion commands, though there are others which will be useful to filter writers. The commands follow in alphabetical order; note that keywords and file specifications may be in lower, upper, or mixed case.


[ previous section | GoServe | next section ]

From 'goserve.doc', version 2.32.
Copyright © International Business Machines Corporation, 1993, 1995.
All rights reserved.