The data structure kc_access_point_str is defined for the object type KC_ACCESS_POINT. In the case of KC_GET_OBJECT, UTM returns the name and address of a local OSI TP access point in kc_access_point_str.
A local OSI TP access point is statically generated using the KDCDEF control statement ACCESS-POINT.
Data structure kc_access_point_str |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The fields in the data structure have the following meanings:
ap_name
Name of the OSI TP access point. The OSI TP access point is uniquely identified within the local UTM application by this name.
application_entity_qualifier
The application entity qualifier (AEQ) of the access point. The AEQ is required for addressing purposes when communicating with heterogeneous communication partners. These communication partners address the access point via the application process title (APT) of the local application and the AEQ of the access point. The AEQ is a positive integer between 1 and 67108863 (= 226-1). You will find more information on the AEQ in the openUTM manual “Generating Applications”.
application_entity_qualifier='0' means that no AEQ is defined for the access point.
presentation_selector
Contains the presentation selector for the address of the OSI TP access point.
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 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 address of the OSI TP access point.
session_selector is a union of type kc_selector (see presentation_selector).
UTM generally returns the session selector as character string (c) in a machinespecific code format (session_selector_code='S'). The 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 access point contains a presentation selector and how to interpret the data returned in presentation_selector.
'N' | N stands for *NONE. The address of the access point 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 OSI TP access point 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 of the access point is X'A2B019CE'. presentation_selector then contains the string 'A2B019CE', presentation_selector_type='X' and presentation_selector_lth =' 4' (four hexadecimal numbers).
presentation_selector_code
Specifies how the presentation selector in presentation_selector is encoded.
UTM returns 'S' if the presentation selector is 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 access point contains a session selector and how to interpret the data returned in session_selector.
'N' | N stands for *NONE. The address of the access point 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 of the OSI TP access point does not contain any session components (session_selector contains blanks).
Otherwise, the value of session_selector_lth lies between '1' and '16'.
If session_selector_type='X', then the string length specified in session_selector is:
2 * session_selector_lth bytes.
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 OSI TP access point. transport_selector always contains a valid value because each access point must be assigned a transport selector in the KDCDEF generation. The transport selector is always to be interpreted as a character string and consists of 1 to 8 printable characters.
The value of transport_selector is a local BCAM application name on BS2000 systems.
listener_id (only on Unix, Linux and Windows systems)
Contains the listener ID of the access point. The listener ID is a positive integer between 0 and 32767.
The listener ID determines which connections are to be administered by the same net process. All connections established via access points and BCAMAPPL names with the same listener ID will be administered by a single net process.
An exception to this are the BCAMAPPL names for communication via the socket interface (SOCKET). They form a number set of their own, i.e. access points with these BCAMAPPL names are not bundled in a single net process, even if the listener ID is the same.
The following fields are only significant for access points of a UTM application under UNXI systems and Windows systems. These fields contain the address components of the access point in the local system. See the openUTM manual “Generating Applications” for more information.
listener_port
Contains the port number of the access point for establishing TCP IP connections.
The port number specified is the port number defined in the KDCDEF generation.
If listener_port = '0', then no listener port number was generated for this access point in the KDCDEF generation.
t_prot
Contains the address format assigned to the access point during KDCDEF generation.
The address formats are specified as follows:
'R' | RFC1006, ISO transport protocol class 0 using TCP/IP and the convergence protocol RFC1006. |
If t_prot contains only blanks, then no address format was defined in the KDCDEF generation.
tsel_format
Contains the format indicator of the T-selectors in the address of the access point.
'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 meaning of the address format is described in the "PCMX documentation" (openUTM documentation).