NQIB gate, INQUIRE_ENQUEUE function

This functions returns information about a particular enqueue. Note that the pool containing the enqueue must be passed since it is a logical extension to the enqueue name.

Input Parameters

POOL_TOKEN
The token identifying the pool from which the enqueue being inquired about belongs.
ENQUEUE_TOKEN
Token representing the enqueue that is being inquired upon.
ENQUEUE_NAME1
A block (addr,len) identifying the name of the enqueue be inquired upon. Or alternatively identifies the prefix of the enqueue name which when combined with the ENQUEUE_NAME2 parameter forms the name of the enqueue being inquired upon.
ENQUEUE_NAME2
Optional Parameter
A block (addr,len) identifying the second half of the enqueue name.

Output Parameters

RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
REASON
Values for the parameter are:
  • ABEND
  • LOOP
  • ENQUEUE_NOT_FOUND
  • INVALID_BROWSE_TOKEN
ENQUEUE_NAME_OUT

A buffer into which the enqueue name is returned. The caller specifies the address and maximum length of the data area into which the enqueue name will be returned. If the enqueue name is too big for the buffer then the data is truncated and an OK response is returned. The actual length of the name is returned in enqueue_name_out_n.

Typically this parameter will only be of interest to callers inquiring by enqueue token.

LOCAL_UOWID
The local UOWID of the UOW which owns or is waiting for the enqueue.
NUM_LOCKED_FAILURES
Returns the number of failed requests for this enqueue whilst it is held in retained state.
NUM_WAITERS
The number of transactions waiting for this enqueue.
POOL_NAME
The name of the pool containing the enqueue.
TRANSACTION_LIFETIME
The number of times the enqueue is held with TRANSACTION lifetime.
STATE
The state that the enqueue is held in.
ACTIVE
The enqueue is held in active state.
RETAINED
The enqueue is held in retained state.
UOW_LIFETIME
The number of times the enqueue is held with UOW lifetime.


dfhs3_NQIBinquire_enqueue.html | Timestamp icon Last updated: Monday, 5 June 2017