X25AM Management Programming Manual

SPI Programming Considerations for the X25AM
Subsystem
X25AM Management Programming Manual—528037-001
4-2
Discontinuing a Command in Progress
will continue to work if it is compiled with new definition files that add new fields to the
token.
The only tokens that can appear more than once in an X25AM command are ZSPI-
TKN-COMMENT, ZCOM-TKN-OBJNAME, and ZCOM-TKN-TRACE-OPT. ZSPI-TKN-
COMMENT is the comment token, described in the SPI Programming Manual. ZCOM-
TKN-OBJNAME is the object-name token, described in Section 5, Common
Definitions. ZCOM-TKN-TRACE-OPT is a token used in the TRACE command, and it
is described in Section 6, Commands and Responses.
If any of the other tokens in a command appear more than once, an error is given
either by the X25AM subsystem or by SCP.
Discontinuing a Command in Progress
General programming considerations for discontinuing a command in progress are
discussed in the SPI Common Extensions Manual.
The X25AM subsystem does support the use of the token ZSPI-TKN-ALLOW-TYPE,
which allows an application to specify, in a command operating on multiple objects,
whether or not the X25AM subsystem should continue immediately to the next object if
it failed on the previous one. If no value is specified for this token, the X25AM
subsystem continues to the next object only if no errors or warnings occurred on the
previous one.
When the X25AM subsystem discontinues a command because of an error or warning,
it immediately sends a reply message to the application. The reply message contains a
context token. The application can choose to resend the command, causing the
X25AM subsystem to proceed to the next object, or to abandon the command.
Receiving and Decoding the Response Buffer
The following programming considerations apply when an application receives and
decodes the response buffer for an X25AM response.
In responses to X25AM commands that operate on objects, a response record always
contains response information for the operation of the command on a single object.
The X25AM subsystem supports multiple response records in a single reply message.
The number of response records returned in one reply message is controlled by the
value of the header token ZSPI-TKN-MAXRESP in the command.
If multiple response records are to be returned in one reply message, the
recommended buffer size in bytes for the response is a predefined value with the
symbolic name ZX25-VAL-MAXBUFLEN. If a single response record is to be returned
in each reply message, the recommended buffer size in bytes for the response is the
predefined value ZX25-VAL-BUFLEN.
The X25AM subsystem does support multiple response records over multiple
messages (continuation) by returning a context token when a response is continued.