TCP/IP TELNET Management Programming Manual

SPI Standard Definitions
Common Definitions
5–4 53474 Tandem Computers Incorporated
ZSPI-TKN-CONTEXT
indicates to the requester within the response buffer that more objects are waiting
to be to processed. This token applies only when a command references more
than one object and the information that is going to be returned cannot fit into one
response buffer. For the TELNET subsystem, this occurs only when an object-
name template has been specified for a command, or the NULL object has been
specified for the LISTOBJECTS command.
The server places in this token the information required to continue the execution
of the command on the next object. When a requester receives a response
containing the context token, the requester copies the context token into a
duplicate of the original command message and sends it to the server. The server
then processes the next object in the set. This sequence is repeated until all of the
objects in the set have been processed.
Once all of the objects in the set have been processed, the ZSPI-TKN-CONTEXT
token is not placed in the reply by the server. Its absence indicates that all objects
of the set have been processed. If the server receives a command with the context
token and no more objects are waiting to be processed, the server returns the
empty response value (ZCOM-ERR-EMPT-RSP) in the return token (ZSPI- TKN-
RETCODE).
The contents of ZSPI-TKN-CONTEXT should not be processed or altered by the
requester; they should only be echoed back to the server in a command. Only one
context token can be present in a command.
ZSPI-TKN-DATALIST
indicates the beginning of a data list within a response. The presence of this token
depends on the value of ZSPI-TKN-MAXRESP. If the value of ZSPI-TKN-
MAXRESP is nonzero, the response tokens, excluding header tokens and the ZSPI-
TKN-CONTEXT token, are enclosed in one or more data lists. Although one
response buffer can contain multiple data lists, each data list must contain
information about only one object type.
ZSPI-TKN-ENDLIST
indicates the end of a data list or an error list within a response.
ZSPI-TKN-ERRLIST
indicates the beginning of an error list. All information about warnings or errors,
except ZSPI-TKN-RETCODE, must be enclosed in an error list. An error list is
present only if the return code is nonzero. The empty response does not contain
an error list.
The contents of an error list are generated by the process returning the error list.
The exception to this rule is a nested error list, which may have been generated by
a different process.