CSLOMRDY: ready request
With the CSLOMRDY request, command processing clients like the IMS control region notify OM that they are ready to process commands. OM does not send commands to a client until this request is processed.
CSLOMRDY syntax
CSLOMRDY DSECT syntax
Use the DSECT function of a CSLOMRDY request to include equate (EQU) statements in your program for the CSLOMRDY parameter list length and return and reason codes.
CSLOMRDY request protocol syntax
CSLOMRDY parameters
- MASTER=NO
- MASTER=YES
- (Optional) - Specifies whether or not the client should be chosen as the command master. If a client specifies MASTER=YES, OM can select that client to be the command master. If the client specifies MASTER=NO, OM selects it to be the command master only if no other client has specified MASTER=YES.
- OMNAME=symbol
- OMNAME=(r2-r12)
- (Optional) - Specifies the 8-byte OM name to which to send the command ready request. If an OM name is not specified, the ready request is sent to all OM address spaces registered in the IMSplex.
- PARM=symbol
- PARM=(r2-r12)
- (Required) - Specifies the CSLOMRDY parameter list. The length of the parameter list must be equal to the parameter list length EQU value defined by ORDY_PARMLN.
- RETCODE=symbol
- RETCODE=(r2-r12)
- (Required) - Specifies a 4-byte field to receive the return code
on output. Possible return codes are described in the following table.
The return code can be from OM (CSLOMRDY) or SCI (CSLSCMSG or CSLSCRQS). If ECB is specified, the RETCODE is not valid until the ECB is posted. The value of the high-order byte in the return code identifies whether SCI (X'01') or OM (X'02') provided the return code. OM return codes are defined in the CSLORR. SCI return codes are defined in CSLSRR.
- RSNCODE=symbol
- RSNCODE=(r2-r12)
- (Required) - Specifies a 4-byte field to receive the reason code on output. OM reason codes are defined in the CSLORR. SCI reason codes are defined in CSLSRR. Possible reason codes are described in the following table.
- SCITOKEN=symbol
- SCITOKEN=(r2-r12)
- (Required) - Specifies a 16-byte field containing the SCI token. This token uniquely identifies this connection to SCI. The SCI token is returned by a successful CSLSCREG FUNC=REGISTER request.
CSLOMRDY return and reason codes
The following table lists the return and reason codes that can be returned on a CSLOMRDY macro request. Also included is the meaning of the reason code (that is, what possibly caused it).
Return code | Reason code | Meaning |
---|---|---|
X'00000000' | X'00000000' | The request completed successfully. |