SPI Programming Manual (H06.24+, J06.13+)

Glossary
SPI Programming Manual—427506-007
Glossary-11
SPI error number
SPI error number. A number that indicates whether a call to an SPI procedure completed
successfully and why it failed if it did. This number is returned in the status parameter
on calls to the SPI procedures. The SPI error number does not reflect the success or
failure of a command; it applies only to errors in the building and decoding of a
message in an SPI buffer.
SPI message header. The initial part of an SPI message. The first word of this header
always contains the value -28; the remainder of the header contains descriptive
information about the SPI message, most of which is accessible as header tokens. The
tokens in an SPI message header differ according to the header type: the header of a
message that contains a command or response differs somewhat from the header of
an event message. An application can use SSGET or EMSGET calls to retrieve the
values of header tokens, and can use SSPUT calls to change the values of some;
however, there are certain basic differences between header tokens and other tokens.
See header token
.
SPI message. A message specially formatted by the SPI procedures for communication
between a management application and a subsystem, or between one subsystem and
another. An SPI message consists of a collection of tokens. To retrieve a token from
the message, the application passes a token code to SPI, which scans for the
appropriate token and returns its value to the application. An SPI message is a single
block of information sent at one time as one interprocess message. The two types of
SPI messages are distinguished by SPI message header type: 1) command and
response messages, and 2) event messages. See header type
.
SPI procedures. The procedures used to build and decode SPI messages. These
procedures are SSINIT, SSNULL, SSPUT, SSPUTTKN, SSGET, SSGETTKN,
SSMOVE, SSMOVETKN, SSIDTOTEXT, and TEXTTOSSID. Corresponding TACL
built-ins are also available.
SPI standard definitions. The set of declarations available for use with the SPI procedures
regardless of the subsystem. Also a set of subsystem-specific declarations for each
subsystem, and some sets of declarations that apply to multiple subsystems exist. An
application using SPI needs the SPI standard definitions and also the subsystem
definitions for all subsystems with which it communicates. See also definition files
and
subsystem definitions
.
statistics token. A response token providing performance data about an object.
status token. A response token whose value indicates the status (current state) of an
object.
structure. A data item with multiple fields, possibly of different types. This kind of data item
corresponds to a DEF in DDL, to a STRUCT in TAL and TACL, and to a RECORD in
COBOL.
structured token. A token whose value is a structure. Some structured tokens are simple
tokens with fixed structures—for example, the error token, ZSPI-TKN-ERROR. Other