NQNQ gate, REACQUIRE_ENQUEUE function
NQ domain doesn't recover enqueues over a CICS restart. Instead resource owners use this function to reacquire enqueues that were held by inflight and indoubt UOWs.
The enqueue can be reacquired in either active or retained state. The calling UOW must currently be shunted.
No MAX_LIFETIME input is provided since such enqueues are only ever associated with a single UOW.
The same rules as documented for the mainline ENQUEUE function apply to the shunt action that will be associated with the reacquired enqueue.
Input Parameters
- POOL_TOKEN
- Token representing enqueue pool from which the enqueue is to be allocated.
- STATE
- The state that the enqueue is to be reacquired in.
- Values for the parameter are:
- ACTIVE
- RETAINED
- ENQUEUE_NAME2
- Optional Parameter
- A block (addr,len) identifying the second half of the enqueue name.
- SHUNT_ACTION
- Optional Parameter
- Indicates the action that is to be performed if the UOW reacquiring the enqueue is shunted again. This parameter acts as an override, if not supplied then the default shunt action specified when the pool was created is assumed for this request.
- Values for the parameter are:
- RELEASE
- The enqueue will be released if the UOW is shunted again.
- RETAIN
- The enqueue will be retained if the UOW is shunted again.
- IGNORE
- The shunt will be ignored. The enqueue will remain in the same state as it is currently held in.
Output Parameters
- REASON
- The values for the parameter are:
- CALLER_NOT_SHUNTED
- ENQUEUE_ACTIVE
- ENQUEUE_LOCKED
- INVALID_POOL_TOKEN
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
- ENQUEUE_TOKEN
- Optional Parameter
- Token returned to represent the enqueue that has been successfully reacquired.