EXTRACT TCPIP

Obtain information about TCPIP characteristics of the current transaction.

Read syntax diagramSkip visual syntax diagram
EXTRACT TCPIP

>>-EXTRACT--TCPIP -+--------------------+----------------------->
                   '-AUTHENTICATE(cvda)-'   

>--+-----------------------------------------------+------------>
   '-CLIENTNAME(data-area)--CNAMELENGTH(data-area)-'   

>--+-----------------------------------------------+------------>
   '-SERVERNAME(data-area)--SNAMELENGTH(data-area)-'   

>--+-CLIENTADDR(data-area)--CADDRLENGTH(data-area)-+------------>
   +-CLIENTADDRNU(data-area)-----------------------+   
   +-SERVERADDR(data-area)--SADDRLENGTH(data-area)-+   
   '-SERVERADDRNU(data-area)-----------------------'   

>--+---------------+--+-------------------------+--------------->
   '-SSLTYPE(cvda)-'  '-TCPIPSERVICE(data-area)-'   

>--+-----------------------+--+----------------------+---------->
   '-PORTNUMBER(data-area)-'  '-PORTNUMNU(data-area)-'   

>--+---------------+--+-----------------------+----------------><
   '-PRIVACY(cvda)-'  '-MAXDATALEN(data-area)-'   

Conditions: INVREQ, LENGERR

 

 

Options

AUTHENTICATE(cvda)
returns a CVDA indicating the authentication requested for the client using this transaction. Possible values are:
  • ASSERTED
  • AUTOAUTH
  • AUTOREGISTER
  • BASICAUTH
  • CERTIFICAUTH
  • NOAUTHENTIC
CADDRLENGTH(data-area)
specifies the length of the buffer supplied on the CLIENTADDR option, and is set to the actual length of the data returned to the application. If the data exceeds the buffer length, a LENGERR condition is raised and the data is truncated.
CLIENTADDR(data-area)
specifies a buffer to contain the client's TCP/IP address.
CLIENTADDRNU(data-area)
specifies a fullword binary field containing the client's TCP/IP address in binary form.
CLIENTNAME(data-area)
specifies a buffer to contain the client's name as known by the Domain Name Server.
CNAMELENGTH(data-area)
specifies the length of the buffer supplied on the CLIENTNAME option, and is set to the actual length of the data returned to the application, or zero if the client's name is not known to the domain name server. If the data exceeds the buffer length, a LENGERR condition is raised and the data is truncated.
Start of changeMAXDATALEN(data-area) End of change
Start of changespecifies a fullword binary field to contain the setting for the maximum length of data that can be received by CICS as an HTTP server.End of change
PRIVACY(cvda)
returns a CVDA indicating the level of SSL encryption used between the transaction and its client for an inbound IIOP request. Possible values are:
  • NOTSUPPORTED
  • REQUIRED
  • SUPPORTED
PORTNUMBER(data-area)
Specifies a 5-character field to contain the port number associated with this transaction in character form. This is the port on which the incoming data that initiated this transaction was received.
PORTNUMNU(data-area)
Fullword field to contain the port number associated with this transaction in binary form. This is the port on which the incoming data that initiated this transaction was received.
SADDRLENGTH(data-area)
specifies the length of the buffer supplied on the SERVERADDR option, and is set to the actual length of the data returned to the application. If the data exceeds the buffer length, a LENGERR condition is raised and the data is truncated.
SERVERADDR(data-area)
specifies a buffer to contain the server's TCP/IP address in dotted decimal character form (nnn.nnn.nnn.nnn).
SERVERADDRNU(data-area)
specifies a fullword binary field containing the server's TCP/IP address in binary form.
SERVERNAME(data-area)
specifies a buffer to contain the server's name as known by the Domain Name Server.
SNAMELENGTH(data-area)
specifies the length of the buffer supplied on the SERVERNAME option, and is set to the actual length of the data returned to the application. If the data exceeds the buffer length, a LENGERR condition is raised and the data is truncated.
SSLTYPE(CVDA)
Returns a CVDA indicating whether the Secure Sockets Layer (SSL) is being used to secure communications for this transaction. Possible values are:
  • SSL
  • NOSSL
  • CLIENTAUTH
TCPIPSERVICE(data-area)
An 8-byte field to contain the name of the TCPIPSERVICE associated with this transaction.

Conditions

INVREQ
RESP2 values:
2
An invalid socket response was received.
5
The command was issued from a non-TCPIP application.
LENGERR
RESP2 values:
1
CLIENTADDR, SERVERADDR, CLIENTNAME or SERVERNAME is specified, but the relevant length field is either not specified, or it is less than or equal to zero.
3
CLIENTADDR is too small to contain the string extracted.
4
SERVERADDR is too small to contain the string extracted.
6
CLIENTNAME is too small to contain the string extracted.
7
SERVERNAME is too small to contain the string extracted.