TCP/IP TELNET Management Programming Manual

SPI Standard Definitions
Common Definitions
53474 Tandem Computers Incorporated 5–5
Multiple error lists can be returned in a single response buffer or even in a single
data list.
ZSPI-TKN-ERROR
is the standard SPI error token described in the Distributed Systems Management
(DSM) Manual. Its value consists of the TELNET subsystem ID and one of the
TELNET subsystem-specific error numbers described in Appendix A, “Error
Numbers and Error Lists.” This token is always present in an error list.
ZSPI-TKN-HDRTYPE
indicates whether the SPI buffer is for an event message or a command. If the
buffer is for a command, the value of this token is ZSPI-VAL-CMDHDR; if the
buffer is for an event message, the value of this token is ZSPI-VAL-EVTHDR.
ZSPI-TKN-MAX-FIELD-VERSION
contains the latest version associated with the non-null fields within all extensible
structured tokens in a command. This value is compared to the server version. If
the server version is earlier than the value of ZSPI-TKN-MAX-FIELD-VERSION,
the command is rejected because the server must be a more recent version.
ZSPI-TKN-MAXRESP
indicates, within a command buffer, the maximum number of response records a
requester can accept in a response buffer. The MAXRESP token default value is
provided when the requester uses the SSINIT procedure. However, if the
requester chooses to specify a value other than the default value for the MAXRESP
token, the requester must specify a value using the SSPUT procedure. The
TELNET interface provides full support for the MAXRESP token; that is, the
requester can specify any of the following values:
-1 indicates that as many response records as will fit in the response buffer can
be returned. Each response record will be enclosed in a data list.
0 indicates that only one response record will be returned in the response
buffer. The response record will not be enclosed in a data list. This is the
default action.
n indicates as many as n responses records, where n is an integer value greater
than 0, will be returned in the response buffer. Each response record will be
enclosed in a data list.
ZSPI-TKN-OBJECT-TYPE
specifies the object-type number of a TELNET object. The value of this token for
the TELNET subsystem is always ZCOM-OBJ-type, where type specifies the object.
The valid object types for the TELNET subsystem are PROC, WINDOW, and
NULL. The object types associated with a command vary with each command.
Refer to Section 6, “Commands and Responses,” for information on which objects
are valid for a specific command.