A SOCKAPI trace record

A typical SOCKAPI record is shown below. This example is a READ Entry.

The lines are numbered for discussion reference only. The description for each line is for the example shown. Lines 1-5 are the separator and header lines that exist for all SOCKAPI trace records. Lines 6-7 are optional header lines.

The parameters for the specific call follow the header lines. For Entry records, the input parameters are shown. For Exit and Asynchronous Complete records, the output parameters are shown and some input parameters might also be shown for reference. Parameters are only formatted if they were specified in the call (optional parameters not supplied are not formatted). The parameters are listed in a specific order for consistency. The parameter names are the same as the names in z/OS Communications Server: IP Sockets Application Programming Interface Guide and Reference with a few exceptions; for example, S is formatted as SOCKET. The parameter name, value, and address are shown on one line if the value fits. Numeric parameter values are in decimal unless followed by a lowercase x indicating hexadecimal. Whenever possible, the values are interpreted (such as ERRNO) for reference.

 1.  ====================================================================00007FE8 
 2.   MVS026    SOCKAPI   60050042  19:31:08.338135   READ Entry                    
 3.  HASID....0027     PASID....0027     SASID..0027     JOBNAME..EZASOKGS          
 4.  TCB......006E6A68 TIE......00008DF8 PLIST..00008E0C DUCB.....0000000C KEY..8
 5.  ADSNAME..GTASOKGS SUBTASK..MACROGIV                 TOKEN....7F6F3798 09902FB0
 6.  LOCAL  PORT..12035      IPADDR.. 9.67.113.58                              
 7.  REMOTE PORT..1034       IPADDR.. F901::32E1                              
 8.   REQAREA..:  00008D90x                                          Addr..00008D90
 9.   SOCKET...:  1                                                  Addr..00008A38
10.   NBYTE....:  40                                                 Addr..00008A34
11.   ALET.....:  00000000x                                          Addr..000089A8
12.   BUF......:  (NO DATA)                                          Addr..000089A8

Line: Description
1: This separator line shows the previous SYSTCPIP component trace record number in hexadecimal.
2: The first data line has the host name (MVS026), trace option (SOCKAPI), trace code (60050042), time, and trace record name.
3: The home, primary, and secondary ASIDs are always the same value (application's ASID) for the SOCKAPI trace option. The job name is also shown.
4: The MVS™ TCB address is shown. TIE (Task Interface Element) is the value of the TASK parameter on the EZASMI macro. The TIE is described in z/OS Communications Server: IP Sockets Application Programming Interface Guide and Reference. The parameter list address and DUCB are shown. Multiple concurrent calls can use the TIE; if so, they must have a different PLIST. The key is the 4-bit storage key from the PSW.
5: The ADSNAME (from the INITAPI call) is formatted in EBCDIC. The subtask name (from the INITAPI call) is formatted in EBCDIC if possible; otherwise, it is formatted in hexadecimal. The token is an 8-byte value, which identifies the INITAPI call instance.
6–7: If applicable, the ports and IP addresses are shown. The ports are formatted in decimal; the IP addresses are in dotted decimal.
8: The REQAREA parameter is shown because it was specified by the application. This is the 4-byte token presented to the application's exit when the response to the function request is complete. At the far right, the address in the application program of the REQAREA parameter is shown.
9: The SOCKET parameter is formatted in decimal. Its address is also shown.
10: The NBYTE parameter (number of bytes to be read) is formatted in decimal, followed by its address.
11: The ALET parameter is formatted in hexadecimal, followed by its address.
12: The BUF parameter currently has no data (because no data has been read) but its address is shown. In the READ Exit (or READ Async Complete) record, if the call was successful, the first 96 bytes of the data are also shown.