OpenTP1 Version 7 Programming Reference COBOL Language

[Contents][Index][Back][Next]

CBLDCMCF('TLSCN ') - Acquire a connection status

Format

PROCEDURE DIVISION specification

CALL 'CBLDCMCF' USING unique-name-1 unique-name-2 unique-name-3

DATA DIVISION specification

01 unique-name-1.
02 data-name-A PIC X(8) VALUE 'TLSCN '.
02 data-name-B PIC X(5).
02 FILLER PIC X(3).
02 data-name-C PIC X(4).
02 data-name-D PIC X(28) VALUE SPACE.
02 data-name-E PIC 9(9) COMP.
02 data-name-F1 PIC X(8).
02 data-name-F2 PIC X(56) VALUE SPACE.
02 data-name-G PIC X(8) VALUE SPACE.
02 data-name-H PIC X(8) VALUE SPACE.
02 data-name-I PIC X(144) VALUE SPACE.
02 data-name-J PIC X(184) VALUE SPACE.
02 data-name-K PIC 9(9) COMP VALUE ZERO.
01 unique-name-2.
02 data-name-L PIC 9(9) COMP VALUE ZERO.
01 unique-name-3.
02 data-name-M PIC 9(9) COMP.
02 unique-name-4.
03 data-name-N PIC X(8).
03 data-name-O PIC X(4).
03 data-name-P PIC X(4).
03 data-name-Q PIC X(40) VALUE LOW-VALUE.

Description

CBLDCMCF('TLSCN ') acquires the status of a connection.

Data areas whose values are set in the UAP

data-name-A

Specify VALUE 'TLSCN[Figure]' for the request code indicating connection status acquisition.

data-name-C

Specifies how to specify the connection whose status is to be acquired.

'LE[Figure]'
Specifies that a logical terminal name is specified for the connection whose status is to be acquired. This value cannot be specified for TP1/NET/NCSB or TP1/NET/X25-Extended.

'CN[Figure]'
Specifies that a connection ID is specified for the connection whose status is to be acquired.

Space
'LE[Figure]' (specification of a logical terminal name) is assumed.

data-name-D

Specify a space.

data-name-E

Specify the MCF communication process identifier of the MCF communication service for the connection that is to be processed. The permitted value range is from 0 to 239.

This argument is ignored when a logical terminal name is used to request connection status acquisition.

If you specify 0, the system searches for the MCF communication service to which the specified connection ID belongs. In a configuration where many MCF communication services are running or when you issue this function many times from a UAP, we recommend that you specify the MCF communication process identifier.

data-name-F1

Specify the logical terminal name or connection ID of the connection whose status is to be acquired. Express the logical terminal name or connection ID as a maximum of 8 bytes. If the specified name is shorter than 8 bytes, pad the name with trailing spaces.

data-name-F2, data-name-G, data-name-H, data-name-I, data-name-J

Specify a space.

data-name-K, data-name-L

Specify 0.

data-name-M

Specify 1 as the number of unique names from unique-name-4 to unique-name-n (number of sets of data-name-N, data-name-O, data-name-P, and data-name-Q).

When the processing is completed, the number of corresponding connections is returned.

data-name-Q

This is an area used by MCF.

Data area to which a value is returned from OpenTP1

data-name-B

A status code of 5 digits is returned.

data-name-M

Returns the number of connections that were processed by this function.

data-name-N

Sets the connection ID of the requested connection.

data-name-O

Sets one of the following values as the protocol type of the requested connection:

'UA[Figure]'
TP1/NET/User Agent (OSAS/UA protocol)

'hds[Figure]'
TP1/NET/HDLC (HDLC protocol)

'X25[Figure]'
TP1/NET/X25 (X.25 protocol)

'TP[Figure]'
TP1/NET/OSI-TP (OSI TP protocol)

'XP[Figure]'
TP1/NET/XMAP3

'HS1[Figure]'
TP1/NET/HSC (HSC1 protocol)

'HS2[Figure]'
TP1/NET/HSC (HSC2 protocol)

'CSB[Figure]'
TP1/NET/NCSB (NCSB protocol)

'NIF[Figure]'
TP1/NET/OSAS-NIF (NIF/OSI protocol)

'SL2[Figure]'
TP1/NET/Secondary Logical Unit - TypeP2 (SLUTYPE-P protocol (secondary station))

'TCP[Figure]'
TP1/NET/TCP/IP (TCP/IP protocol)

'X2E[Figure]'
TP1/NET/X25-Extended (X.25 protocol)

data-name-P

Sets one of the following values as the status of the requested connection:

'ACT[Figure]'
Connection has been established.

'ACTB'
Connection establishment processing is under way.

'DCT[Figure]'
Connection has been released.

'DCTB'
Connection release processing is under way.

Status codes

Status code Explanation
00000 Normal termination.
71001 CBLDCMCF('TLSCN ') cannot be accepted because MCF is under start processing.
71004 A memory shortage occurred during CBLDCMCF('TLSCN ') processing.
71005 A communication error occurred. For the cause, see the message log file.
71006 An internal error occurred. For the cause, see the message log file.
71007 The specified connection name has not been registered.
71008 The specified logical terminal name has not been registered.
71009 CBLDCMCF('TLSCN ') is not supported by the applicable communication process.
71010 Although the request to acquire the connection status was issued to the MCF communication process, the request was not accepted. For the cause, see the message log file.
71011 CBLDCMCF('TLSCN ') cannot be accepted because the connection has been deleted.
71014 The specified logical terminal name belongs to TP1/NET/NCSB or TP1/NET/X25-Extended; or, the specified connection group name belongs to TP1/NET/OSI-TP or TP1/NET/TCP/IP.
72028 The value specified for data-name-A is invalid.
72052 A nonzero value is specified for data-name-K.
72053 A nonzero value is specified for data-name-L.
72058 The value specified for data-name-C is not 'LE[Figure]', 'CN[Figure]', or a space.
72059 The value specified for data-name-D is not a space.
72061 A value smaller than 0 or greater than 239 is specified for data-name-E.
72063 data-name-F1 begins with a space.
72065 The value specified for data-name-F2 is not a space.
72066 The value specified for data-name-G is not a space.
72068 The value specified for data-name-H is not a space.
72070 The value specified for data-name-I is not a space.
72072 The value specified for data-name-J is not a space.
72074 The character string specified for data-name-F1 contains an invalid character.
72076 The value 1 is not specified for data-name-M.