Table of Contents
Advertisement
SPI PROGRAMMING CONSIDERATIONS FOR TR3271
Receiving and Decoding the Response Buffer
RECEIVING AND DECODING THE RESPONSE BUFFER
The following programming considerations apply when an applica-
tion receives and decodes the response buffer.
In responses to TR3271 commands that operate on objects, a
response record always contains response information for the
operation of the command on a single object.
The 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.
The supported values of the
token ZSPI-TKN-MAXRESP are 0, -1, and n (any value greater than
0).
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 ZCOM-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 ZCOM-VAL-BUFLEN.
The subsystem supports multiple response records over multiple
messages (continuation) by returning a context token when a
response is continued.
The subsystem also supports the use of the token ZSPI-TKN-
RESPONSE-TYPE, which allows an application to specify, in a
command operating on multiple objects, which kinds of response
records should be returned--one for every object, or only those
for objects on which errors or warnings occurred.
If no value is
specified for this token, the subsystems return a response record
for every object.
Note that for commands such as the INFO command whose purpose
is to return information, using ZSPI-TKN-RESPONSE-TYPE to request
the return of only those response records for objects on which
errors or warnings occurred can result in no information being
returned.
The responses to the INFO, RESETSTATS, STATISTICS, and STATUS
commands each contain an extensible structured token that returns
the requested information.
The object-name token ZCOM-TKN-OBJNAME can appear more than once
in a response record returned by the LISTOBJECTS command.
This
is the only case where a token might appear multiple times in a
response record.
4-3
Advertisement
Table of Contents
