NQNQ gate, INTERPRET_ENQUEUE function

This function interprets the passed enqueue before it being returned by the EXEC CICS INQUIRE UOWENQ command. The function takes the enqueue to be interpreted as input and returns ENQUEUE_TYPE, RESOURCE and QUALIFIER to the caller (EXEC layer).

Each enqueue pool can either
  • not have an interpreter and consequently not have its enqueues returned by the INQUIRE UOWENQ command
  • rely upon a default interpreter supplied by NQ domain, (DFHNQIE)
  • supply its own interpreter routine.
This is specified when the pool is created.

Input Parameters

ENQUEUE_NAME
A block (addr,len) identifying the full name of the enqueue to be interpreted.
ENQUEUE_NAME2_LENGTH
The length of the second part of the enqueue name if the enqueue was originally specified in two parts (i.e. ENQUEUE_NAME1 and ENQUEUE_NAME2). If the ENQUEUE_NAME2 parameter wasn't originally specified for this enqueue then this will contain zero.
POOL_NAME
Name of the pool containing the enqueue to be interpreted. Note that an interpreter may interpret enqueues from more than one pool.
POOL_TOKEN
Token corresponding to the pool containing the enqueue to be interpreted
QUALIFIER_BUFFER

A buffer into which the data for the QUALIFIER field is returned. The caller specifies the address and maximum length of the data area into which the QUALIFIER data will be returned. If the data 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 qualifer_buffer_n.

If there is no QUALIFIER data then no data should be returned and the length of the data (qualifier_buffer_n) should be returned as zero.

RESOURCE_BUFFER
A buffer into which the data for the RESOURCE field is returned. The caller specifies the address and maximum length of the data area into which the RESOURCE data will be returned. If the data 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 resource_buffer_n.

Output Parameters

REASON
The values for the parameter are:
  • INVALID_ENQUEUE
ENQUEUE_TYPE
The TYPE of the enqueue being returned. The values map onto the CVDA values for the TYPE field as detailed under the EXEC CICS INQUIRE UOWENQ command.
Values for the parameter are:
  • DATASET
  • DISPATCHER
  • EXECENQ
  • EXECENQADDR
  • EXECENQPLEX
  • FILE
  • TDQUEUE
  • TSQUEUE
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.


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