(a) In a multi-thread environment

PROCEDURE DIVISION

 
CALL  'CBLDCCLS'  USING  identifier-1
 

DATA DIVISION

 
01  identifier-1.
  02  data-name-A  PIC  X(8)  VALUE 'O-NOTIFY'.
  02  data-name-B  PIC  X(5).
  02  FILLER  PIC  X(3).
  02  data-name-C  PIC  S9(9)  COMP VALUE ZERO.
  02  data-name-D  PIC  9(4)  COMP.
  02  FILLER  PIC  X(2).
  02  FILLER  PIC  9(4)  COMP.
  02  FILLER  PIC  X(2).
  02  data-name-F  PIC  9(9)  COMP.
  02  data-name-G  PIC  X(256).
  

(b) In a single-thread environment

PROCEDURE DIVISION

 
CALL  'CBLDCCLT'  USING  identifier-1
 

DATA DIVISION

 
01 identifier-1.
  02 data-name-A  PIC X(8) VALUE 'O-NOTIFY'.
  02 data-name-B  PIC X(5).
  02 FILLER PIC X(3).
  02 data-name-C PIC S9(9) COMP VALUE ZERO.
  02 data-name-D PIC 9(4) COMP.
  02 FILLER PIC X(2).
 

CBLDCCLS('O-NOTIFY') creates an environment for using the facility for receiving one-way messages from the server.

CBLDCCLS('O-NOTIFY') and CBLDCCLS('C-NOTIFY') are used in a pair.

• data-name-A
  Set VALUE 'O-NOTIFY' as a request code for starting reception of one-way messages.
  
• data-name-C
  Set 0.
  
• data-name-D
  Set the client's port number in the range from 5001 to 65535. Specify a unique port number for each process or thread when multiple processes or multiple threads are executed simultaneously on the same machine.
  
• data-name-G
  Specify the path name of the client environment definition file. The path name must be specified with the full path or with a relative path from the current drive and the current directory. The following shows the order in which files are loaded when the path name is specified.
  
  • In TP1/Client/P
    Client environment definition files are loaded in the following order:
    1. The BETRAN.INI file in the Windows directory
    2. The client environment definition file specified in data-name-G
    The definitions in both the client environment definition file and the BETRAN.INI file take effect.
    If the same definition is specified in each file with a different value, the value specified in the client environment definition file takes effect.
    If neither the client environment definition file nor the BETRAN.INI file contains the necessary specification, TP1/Client/P uses the defaults.
    
  • In TP1/Client/W
    All definitions specified in the environment variables will be invalid. TP1/Client/W uses the defaults for definitions that are not specified in the client environment definition file specified in data-name-G.
    
  You can omit the path name by specifying a blank at the beginning of data-name-G. The following describes the operation when the path name is omitted.
  
  • In TP1/Client/P
    TP1/Client/P uses the BETRAN.INI file in the Windows directory as the client environment definition file. If the BETRAN.INI file does not exist or if the contents of the definition file are invalid, TP1/Client/P uses the defaults.
    
  • In TP1/Client/W
    TP1/Client/W uses the values specified in the environment variables. If an environment variable is not specified, TP1/Client/W uses the default.
    
  The following describes operation when the client environment definition file specified in data-name-G does not exist or when the contents of the definition file are invalid.
  
  • In TP1/Client/P
    TP1/Client/P uses the BETRAN.INI file in the Windows directory as the client environment definition file. If the BETRAN.INI file does not exist or if the contents of the definition file are invalid, TP1/Client/P uses the defaults.
    
  • In TP1/Client/W
    TP1/Client/W uses the defaults. The values specified in the environment variables will be invalid.
    

• data-name-B
  A five-digit status code is returned.
  
• data-name-F
  The one-way message reception ID is returned. Do not destroy the returned one-way message reception ID before CBLDCCLS('C-NOTIFY') is executed.
  

Status code	Meaning
00000	The program normally terminated.
02501	The value specified in the data area is incorrect.
02502	CBLDCCLT('O-NOTIFY') has already been executed. This status code is not returned if CBLDCCLS('O-NOTIFY') is executed.
02503	Initialization failed. Alternatively, the client environment definition is specified incorrectly.
02504	A necessary amount of buffer could not be allocated.
02547	The specified port number has already been used.

• After CBLDCCLS('O-NOTIFY') terminates normally, always execute CBLDCCLS('C-NOTIFY'). If CBLDCCLS('C-NOTIFY') is not executed, the resources used by CBLDCCLS('O-NOTIFY') may remain.
• Specify a unique port number in data-name-D for each process or thread when multiple processes or multiple threads are executed simultaneously on the same machine. Do not specify a port number for use by the operating system or other programs even if one can be specified in data-name-D. If you specify a port number in this case, response data might not be received correctly. The port numbers used by the operating system differ depending on the operating system. For details, see the documentation of your operating system.