z/OS JES2 Macros
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


$QBUSY – Set or test the JQE busy–system indicator

z/OS JES2 Macros
SA32-0996-00

Use $QBUSY to set or test the busy system indicator for a job queue element (JQE).

Format description

Read syntax diagramSkip visual syntax diagram
>>-+--------+--$QBUSY--JQE--=--+-(--R--n--)-+------------------->
   '-symbol-'                  '-label------'   

>--,--ACTION--=--+-ON------------------------+------------------>
                 +-OFF-----------------------+   
                 +-(--TEST--,--ANY--)--------+   
                 +-(--TEST--,--LOCAL--)------+   
                 +-(--TEST--,--field--)------+   
                 '-(--TEST--,--(--R--n--)--)-'   

>--+--------------------+--+---------------------------+-------->
   '-,--CAT--=--address-'  |                 .-NO----. |   
                           '-,--SETDEVID--=--+-YES---+-'   
                                             '-value-'     

>--+----------------------------+------------------------------->
   '-,--BUSY--=--+-label------+-'   
                 '-(--R--n--)-'     

>--+-------------------------------+--+---------------------+--->
   '-,--NOTBUSY--=--+-label------+-'  |             .-YES-. |   
                    '-(--R--n--)-'    '-,--REAL--=--+-NO--+-'   

>--+----------------------+------------------------------------><
   |              .-YES-. |   
   '-,--TRACE--=--+-NO--+-'   

JQE=
Specifies the address of the JQE whose busy indicator is to be set, reset, or tested. If you use register notation, provide the address of the JQE in the specified register. If you specify a label, that label is the address of the JQE. (For example, you can specify JQE=JQE if you set a base register for the JQE DSECT.)
ACTION=
Specifies whether the busy indicator for this JQE is to be set on (ON) or turned off (OFF).
ON
Indicates this member is processing this element.
OFF
Indicates that this element is not being processed by any members.
(TEST,ANY)
Indicates that the JQE should be tested to determine if the JQE is busy on any member of the MAS.
(TEST,LOCAL)
Indicates that the JQE should be tested to determine if the JQE is busy on this member of the MAS.
(TEST,field)
Indicates that the JQE should be tested to determine if the JQE is busy on the member of the MAS whose member number is specified in the indicated 1-byte field.
(TEST,(Rn))
Indicates that the JQE should be tested to determine if the JQE is busy on the member of the MAS whose member number is specified in the indicated register.
Note: Whenever setting ACTION=(TEST,...), you must also specify either BUSY= or NOTBUSY= to indicate to JES2 where it should branch based on the test result.
CAT=
Specifies the address of the update mode CAT. If the caller has an update mode CAT associated with the class the job is currently active in, the address must be passed to $QBUSY.
SETDEVID=value|YES|NO
Specifies whether (YES) or not (NO) the device id in the JQE is to be set. If a value is specified, it will be set to JQEDEVID. SETDEVID=NO is the default.
BUSY=
Specifies a label or register to which to branch if the JQE is busy on the particular member of the MAS.

BUSY= is only valid if you also specify ACTION=(TEST,...).

NOTBUSY=
Specifies a label or register to which to branch if the JQE is not busy on the particular member of the MAS.

BUSY= is only valid if you also specify ACTION=(TEST,...).

REAL=
Specifies whether this JQE is a ‘real’ JQE within the JES2 checkpoint data set (YES) or a prototype JQE in a work area (NO). If REAL=YES, JES2 validates the JQE.

TRACE=YES and REAL=NO are mutually exclusive.

TRACE=
Specifies whether (YES) or not (NO) this modification to the busy indicator is to be traced by the SYSjes2 component trace. See z/OS MVS Diagnosis: Tools and Service Aids for further information concerning SYSjes2 component tracing.
YES
Indicates that tracing is set on for this $QBUSY call.

TRACE=YES and REAL=NO are mutually exclusive.

NO
Indicates that tracing is set off for this $QBUSY call.
Note:
  1. TRACE= is only valid if you also specify either ACTION=ON or ACTION=OFF.
  2. IBM® suggests that you do not turn SYSjes2 tracing off. If JES2 encounters a problem related to $QBUSY services, the data obtained from this trace can significantly aid debugging procedures.

Environment

  • Main task.
  • $WAIT or WAIT cannot occur.
Note:
  1. On return from the $QBUSY routine, register 15 will contain a 0 (zero) if you specified ACTION=ON or ACTION=OFF. JES2 provides no return codes for ACTION=(TEST,...).
  2. Register usage
    • $QBUSY uses registers R0, R1, R14, and R15 as work registers.
    • On entry, $QBUSY requires that R11 contain the address of the HCT.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014