WAN Manager SPI Programming Guide

Commands and Response Tokens
WAN Manager SPI Programming Guide—540013-001
4-4
Description of Body Tokens
ZSPI-TKN-OBJECT-TYPE
specifies the object-type number of the WAN manager object. The value of this
token format is ZCOM-OBJ-object-type and is specified in the call to SSINIT. If
not specified, it defaults to ZSPI-VAL-NULL-OBJECT-TYPE.
ZSPI-TKN-SERVER-VERSION
specifies the server version of the WAN manager (WANMAN) process. This token
is provided only by subsystems or other programs that act as a server. In these
cases, the value of this token is a 16-bit unsigned integer representing the version
of the subsystem or server program. SSINIT places this value in the header token
to check for version compatibility. If not specified, the version number defaults to 0
(zero).
ZSPI-TKN-SSID
identifies the subsystem that processes the SPI command. This subsystem is
defined as ZSPI-VAL-TANDEM.ZSPI-SSN-subsystem.version. This value is
specified in the call to SSINIT, for example, ZWAN-VAL-SSID.
ZSPI-TKN-USEDLEN
contains the length of the used portion of the buffer. This value is updated by
SSPUTTKN and SSMOVE each time they add information to the buffer, and can
be retrieved using SSGETTKN.
ZSPI-TKN-BUFLEN
contains the SPI buffer length. This value is set by SSINIT. This token can be
retrieved using SSGET and can be modified using SSPUT.
Description of Body Tokens
The command and response body tokens described here are not exhaustive. For more
information, see the SPI Reference Summary, SPI Programming Manual, and SPI
Common Extensions Manual.
ZCOM-TKN-OBJNAME
specifies the fully qualified name of the object to be selected for processing. This
token must occur at least once in the command. If there are multiple occurrences
of this token, the WAN manager returns a response record for each token. The
basic SPI command language rules about returning multiple response records are
followed. The ZCOM-TKN-CONTEXT token indicates when you must use more
than one SPI buffer to return the full command response. When more than one
object name is specified, the same command is applied to all named objects. If
different actions are desired on each named object, use separate commands.