(a) In a multi-thread environment

PROCEDURE DIVISION

 
CALL 'CBLDCCLS' USING identifier-1 identifier-2 identifier-3
 

DATA DIVISION

01 identifier-1.
   02  data-name-A  PIC X(8) VALUE 'ASMRECV'.
   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 S9(9) COMP.
01 identifier-2.
   02  data-name-E  PIC S9(9) COMP.
   02  data-name-F  PIC X(n).
01 identifier-3.
   02  data-name-G  PIC 9(9) COMP.
 

(b) In a single-thread environment

PROCEDURE DIVISION

 
CALL 'CBLDCCLT' USING identifier-1 identifier-2
 

DATA DIVISION

 
01 identifier-1.
   02  data-name-A  PIC X(8) VALUE 'ASMRECV'.
   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 S9(9) COMP.
01 identifier-2.
   02  data-name-E  PIC S9(9) COMP.
   02  data-name-F  PIC X(n).
 

Uses the message assembly facility to receive messages. When this facility is used, the statement receives four-byte message information, and then receives data equivalent to the size set in the message information. The statement then stores the data in data-name-F. The four-byte message information is not stored in data-name-F. The length of the received message is stored in data-name-E. The message length stored in data-name-E does not include the message information length.

If Y is specified for DCCLTDELIVERYCHECK of the client environment definition, the statement also uses the message delivery confirmation facility. In this case, the statement receives 11-byte message information, and then receives data equivalent to the size set in the message information. The function then stores the data in data-name-F. The 11-byte message information is not stored in data-name-F. The length of the received message is stored in data-name-E. The message length stored in data-name-E does not include the message information length. If the received message information includes a response request, the function sends 11-byte message information, and then returns control to the CUP.

Before executing CBLDCCLS('ASMRECV '), make sure that you execute CBLDCRPS('OPEN ') in which 8 or 16 is specified in data-name-C.

• data-name-A
  Set VALUE 'ASMRECV' as the request code for receiving a message.
  
• data-name-C
  Specify whether to release the connection after receiving a message.
  0: After a message is received, the connection is not released until CBLDCRPS('CLOSE ') is executed (exception: an error occurs).
  2: After a message is received, the connection is released. If the message information received when the message delivery confirmation facility is being used includes a response request, the connection is released after message information has been sent.
  
• data-name-D
  Specify the maximum time (in seconds) that the statement waits for a message to arrive. The value must be an integer from -1 to 65,535.
  

  If -1 is specified:

  The statement waits indefinitely for a message.

  If 0 is specified:

  The statement does not wait for a message. If there is no message to be received, the statement returns a 02507 error.

  If any value from 1 to 65,535 is specified:

  The statement waits for a message, but returns a 02507 error if no message arrives within the specified number of seconds.

If a divided message arrives, the statement repeats the receive processing until the entire message arrives. The timeout specified by this argument is applied every time the statement attempts a reception. If you want to use the value of this argument as the maximum response wait time for the client, specify the 00000002 option for DCCLTOPTION of the client environment definition.

• data-name-E
  Specify the length of the message to be received.
  
• data-name-F
  Specify the area where the received message will be stored. The area must be larger than the length specified in data-name-E.
  
• data-name-G
  Specify the client ID received by CBLDCCLS('CLTIN ') or CBLDCCLS('EXCLTIN ').
  

• data-name-B
  5-digit status code
  
• data-name-E
  The length of the received message is stored in this area. The stored length does not include the length of the message information.
  If a timeout occurs, the length of the data received before the timeout is stored.
  
• data-name-F
  The received message is stored in this area. The stored message does not include message information.
  If a timeout occurs, the data received before the timeout is stored.
  

Status code	Meaning
00000	Normal termination
02501	Invalid argument
02502	Possible causes are as follows: CBLDCRPS('OPEN ') has not been executed. CBLDCRPS('OPEN ') has been executed, but 8 or 16 is not specified for data-name-C.
02504	Insufficient memory
02506	A network error occurred. The connection is released.
02507	Message reception timed out. The connection is released.
02518	A system error occurred. If the error is a network error, the connection is released.
02538	Insufficient resource
02542	The remote system released the connection.
02544	The client ID specified for data-name-G differs from the one received by CBLDCCLS('CLTIN ') or CBLDCCLS('EXCLTIN ').
02546	The area prepared by the CUP was too small to receive the message from the remote system. The connection is released.
02548	An invalid message was received. The connection is released.

• CBLDCCLS('ASMRECV ') returns control to the CUP in the following cases only:
  
  • When the statement has received message data equivalent to the length set in the message information
  • When a network error has occurred
  • When message reception has timed out
  • When the connection is released by the remote system
  • When the message storage area (specified by data-name-F) is too small to store the message sent by the remote system
  • When an invalid message has been received
• If the message assembly and message delivery confirmation facilities are used, short packets are used for sending and receiving. As a result, transmission processing might take time. If more time might be required, specify Y for DCCLTTCPNODELAY of the client environment definition.