The data structure kc_osi_con_str is defined for the object type KC_OSI_CON. In the case of KC_GET_OBJECT, UTM returns the name and address of an OSI TP partner application and the status of the connection to the partner application in kc_osi_con_str.
An OSI TP connection is created with the KDCDEF control statement OSI-CON.
mod1 | Data structure kc_osi_con_str |
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
x(GIR) |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
1 The contents of the field can be modified with KC_MODIFY_OBJECT; see "obj_type=KC_OSI_CON"
The fields in the data structure have the following meanings:
oc_name
Contains the name of a connection that was generated with OSI-CON for the communication via the OSI TP protocol. oc_name uniquely identifies the connection in the local UTM application.
osi_lpap
Specifies the partner application for which the connection is defined. osi_lpap contains the name of the OSI-LPAP partner assigned to the partner application.
local_access_point
Contains the name of an OSI TP access point that is defined for the local application (KDCDEF statement ACCESS-POINT). The connection to the partner application is established via this access point.
presentation_selector
Contains the presentation selector of the partner application. The presentation selector is a component of the partner address.
presentation_selector is a field of type kc_selector:
union kc_selector |
|
|
UTM generally returns the presentation selector as character string (c) in a machine-specific code format (presentation_selector_code='S'). The character string is a maximum of 16 characters long. The presentation_selector field is padded with blanks starting after the position specified in the presentation_selector_lth length field.
In special cases, the presentation selector is returned as a hexadecimal string (x). Each half byte is represented by a character, for example the hexadecimal number A2 is returned as the string 'A2' (2 characters). If the presentation selector is a hexadecimal number, then UTM returns up to 32 bytes.
You determine how to interpret the contents of the presentation_selector with the presentation_selector_type field.
If the address of the access point does not contain a presentation selector, then the presentation_selector field contains only blanks. In this case, presentation_selector_type = 'N' and presentation_selector_lth = '0'.
session_selector
Contains the session selector of the partner application. The session selector is a component of the partner address.
session_selector is a union of type kc_selector (see presentation_selector).
UTM generally returns the session selector as character string (c) in machinespecific code (session_selector_code='S'). The character string is a maximum of
16 characters long. The session_selector field is padded with blanks starting after the position specified in the session_selector_lth length field.
In special cases, the session selector is returned as a hexadecimal string (x). Each half byte is represented by a character. If the session selector is a hexadecimal number, then UTM returns up to 32 bytes in session_selector.
You determine how to interpret the contents of the session_selector with the session_selector_type field.
If the address of the access point does not contain a presentation selector, then the session_selector field contains only blanks. In this case, session_selector_type = 'N' and session_selector_lth = '0'.
presentation_selector_type
Specifies if the address of the partner application contains a presentation selector and how to interpret the data returned in presentation_selector.
'N' | N stands for *NONE. The address of the partner application does not contain a presentation selector, presentation_selector contains only blanks and presentation_selector_lth='0'. |
'C' | The data of the presentation selector in presentation_selector is to be interpreted as a character string. A maximum of the first 16 bytes of presentation_selector contain data. |
'X' | The presentation selector in presentation_selector is a hexadecimal number. |
presentation_selector_lth
Contains the length of the presentation selector (presentation_selector) in bytes. If presentation_selector_lth ='0', then the address of the partner application does not contain any presentation components (presentation_selector contains blanks). Otherwise, the value of presentation_selector_lth lies between '1' and '16'.
If presentation_selector_type='X', then the string length specified in presentation_selector is: 2 * presentation_selector_lth bytes.
Example
The presentation selector is X'A2B019CE'. presentation_selector then contains the string 'A2B019CE', presentation_selector_type='X' and presentation_selector_lth =' 4'.
presentation_selector_code
Specifies how the presentation selector in presentation_selector is encoded.
UTM returns 'S' if the presentation selector will be returned as a character string (presentation_selector_type = 'C').
'S' means: machine-specific code (default code, EBCDIC on BS2000 systems and ASCII on Unix, Linux and Windows systems).
If presentation_selector_type = 'X' or 'N', then UTM returns a blank in the presentation_selector_code field.
session_selector_type
Specifies if the address of the partner application contains a session selector and how to interpret the data returned in session_selector.
'N' | N stands for *NONE. The address of the partner application does not contain a session selector, session_selector contains only blanks and session_selector_lth='0'. |
'C' | The data of the session selector in session_selector is to be interpreted as a character string. A maximum of the first 16 bytes of session_selector contain data. |
'X' | The session selector in session_selector is a hexadecimal number. |
session_selector_lth
Contains the length of the session selector (session_selector) in bytes. If session_selector_lth ='0', then the address does not contain any session components (session_selector contains blanks). Otherwise, the value of session_selector_lth lies between '1' and '16'.
session_selector_code
Specifies how the session selector in session_selector is encoded.
UTM returns 'S' if the session selector will be returned as a character string (session_selector_type = 'C').
'S' means: machine-specific code (default code, EBCDIC on BS2000 systems and ASCII on Unix, Linux and Windows systems).
If session_selector_type = 'X' or 'N', then UTM returns a blank in the session_selector_code field.
transport_selector
Contains the transport selector of the address of the partner application. The transport selector is a component of the partner address. transport_selector always contains a valid value because each communication partner must be assigned a transport selector so that it is addressable within its system. The transport selector is always to be interpreted as a character string and consists of 1 to 8 printable characters.
network_selector
Network component (network selector) of the partner address.
BS2000 systems:
network_selector contains the name of the computer on which the partner application runs. This is the name under which the computer is known to BCAM.
Unix, Linux or Windows systems:
network_selector contains the name of the partner computer by means of which UTM searches the IP address of the partner computer in the name service.
If the real computer name is longer than 8 characters:
The network_selector field contains a symbolic local name assigned for this computer by the transport system.
The complete name, up to 64 characters long, can be taken from the network_selector_long field.
active Specifies if this connection is set to active or if the connection is a substitute
connection that is presently inactive. It is possible to generate several connections to a partner application. Only one of these connections, however, may be active at any one time.
'Y' | The connection is set to active. |
'N' | The connection is inactive. |
map (only on Unix, Linux and Windows systems)
Specifies whether UTM performs a code conversion (ASCII <-> EBCDIC) for user messages without any formatting flags (abstract syntax UDT) which are exchanged between the partner applications.
'U' | (USER) |
'1', '2', '3', '4' (SYS1 | SYS2 | SYS3 | SYS4) | |
UTM converts the user messages according to the code tables provided for the code conversion, see section "Code conversion" in the openUTM manual “Generating Applications”, i.e.:
openUTM assumes that the messages contain only printable characters. | |
For more information on code conversion, please refer to the openUTM manual „Programming Applications with KDCS”; keyword „code conversion". | |
UTM returns the components of the transport address of the partner application in the following fields. See also the openUTM manual “Generating Applications” for more information.
listener_port
Contains the port number of the address of the partner application.
If listener_port = '0', then no listener port number was generated in the KDCDEF generation.
t_prot (only on Unix, Linux and Windows systems)
Contains the address format of the transport address. The address format specifies the transport protocol used for communication with the partner application.
'R' | RFC1006, ISO transport protocol class 0 using TCP/IP and the convergence protocol RFC1006. |
If t_prot contains a blank, then no address format was defined in the KDCDEF generation.
tsel_format (only on Unix, Linux and Windows systems)
Specifies the format in which the T-selectors of the partner address is stored in the TS directory:
'T' | TRANSDATA format |
'E' | EBCDIC character format |
'A' | ASCII character format |
If tsel_format contains a blank, then no format indicator was defined in the KDCDEF generation.
The meanings of the address formats are described in the "PCMX documentation" (openUTM documentation).
ip_addr (only on Unix, Linux and Windows systems)
Returns the IP address used by UTM for this connection from the object table of the application if the address is an IPv4 address.
UTM uses the address to establish connections to partner applications. UTM reads the IP address from the host name database when the application is started using the generated processor name (networ_selector).
An IPv6 address is returned in the ip_addr_v6 field.
If there is no IPv4 address in the object tables for the client, UTM returns blanks in ip_addr.
ip_addr_v6 (only on Unix, Linux and Windows systems)
Returns the IP address used by UTM for this connection from the object table of the application if the address is an IPv6 address or an IPv4 address embedded in IPv6 format.
An IPv4 address is returned in the ip_addr field (see above).
If there is no IPv6 address in the object tables for the client, UTM returns blanks in ip_addr_v6.
ip_v (only on Unix, Linux and Windows systems)
Specifies whether the IP address used by openUTM for this connection is an IPv4 or an IPv6 address:
'V4' | IPv4 Address. |
'V6' | IPv6 address or IPv4 address embedded in IPv6 format. |
network_selector_long
Network component (network selector) of the partner address.
BS2000 systems:
network_selector_long contains the name of the computer on which the partner application runs. This is the name under which the computer is known to BCAM.
Unix, Linux or Windows systems:
network_selector_long contains the name of the partner computer by means of which UTM searches the IP address of the partner computer in the name service.