SNAX/APC Application Programming Manual

Interprocess Communications and Units of Work
SNAX/APC Application Programming Manual—138786
2-4
The IPC Header
A reply from SNAX/APC to the TP is similar in form to the request shown
in Figure 2-2. The reply consists of the following:
•
An IPC header, with reply and return codes supplied by the SNAX/APC system
•
One or more reply UOWs, also with reply and return codes
The reply from SNAX/APC contains one reply UOW for each successfully processed
request UOW. The SNAX/APC system processes the verb request UOWs in the same
order as they appear in the IPC, and therefore the reply UOWs appear in the same order
as the verb requests.
Each reply UOW has a standard header that contains a return code as shown in
Figure 2-3
. The return code identifies the status of the corresponding request UOW. For
example, RC-OK (value 0) indicates that the requested operation completed
successfully.
The IPC Header
The IPC header is a ten-word data structure containing information that uniquely
identifies the TP request to the SNAX/APC process (in addition to version level and
UOW count fields).
The following COBOL definition illustrates the IPC header:
?SECTION QUALIFIED-IPC-HEADER,TANDEM
01 QUALIFIED-IPC-HEADER.
02 REQ-CODE PIC S9(4) COMP.
88 STOP-ON-ERROR VALUE IS -2.
02 REP-CODE REDEFINES REQ-CODE PIC S9(4) COMP.
88 ALL-UOWS-OK VALUE IS 0.
88 UOWS-WITH-ERROR VALUE IS 2.
88 REQ-ERROR VALUE IS 3.
02 VERSION-CODE PIC X(2).
02 HEADER-RETURN-CODE PIC S9(4) COMP.
88 IPC-OK VALUE IS 0.
88 INVALID-VERSION-CODE VALUE IS 1.
88 INVALID-RESOURCE-ID VALUE IS 2.
88 SERVICE-DENIED VALUE IS 3.
88 INVALID-UOW-HEADER VALUE IS 4.
88 REQ-TOO-LONG VALUE IS 5.
88 REQ-TOO-SHORT VALUE IS 6.
88 REP-TOO-LONG VALUE IS 7.
88 INVALID-REQ-CODE VALUE IS 8.
88 SNAX-FILE-ERROR VALUE IS 9.
88 OUT-OF-RESOURCES VALUE IS 10.
02 HEADER-RETURN-CODE-DETAIL PIC S9(4) COMP.
88 INVALID-INDICATOR VALUE IS 302.
88 INVALID-TPNAME VALUE IS 303.
88 INVALID-LUNAME VALUE IS 304.
88 INVALID-SEND-LENGTH VALUE IS 305.
88 INVALID-TYPE VALUE IS 306.
88 INVALID-APC-VERB VALUE IS 307.