NQNQ gate, CREATE_ENQUEUE_POOL function

This function creates a separate enqueue pool for the caller. A token is returned which the caller specifies on all requests associated with that pool.

Input Parameters

ERROR_LEVEL
Indicates the severity of the error response that is to be returned for the following errors made while using this pool:
  • DEQUEUE
    • Enqueue_not_owned
    • Enqueue_locked
  • REACQUIRE_ENQUEUE
    • Enqueue_locked
    • Enqueue_active
  • DEACTIVATE
    • Enqueue_not_owned
    • Enqueue_not_active
The possible values for ERROR_LEVEL are as follows:
EXCEPTION_RESPONSE
These errors are to be returned with an exception response.
INVALID_RESPONSE
These errors are to be returned with an invalid response. (i.e. FFDC is to be performed).
Note: It is expected that only the EXEC and the KC enqueue pools will specify EXCEPTION_RESPONSE since the DFHKC service previously used by them allowed these sorts of error to go by undetected.
Values for the parameter are:
  • EXCEPTION_RESPONSE
  • INVALID_RESPONSE
EXEC_INTERPRETER
Indicates how enqueues belonging to the enqueue pool are to be interpreted by the EXEC CICS INQUIRE UOWENQ command. The possible values are as follows:
NONE
No interpreter has been supplied so enqueues belonging to this pool will be ignored by the INQUIRE UOWENQ command.
DEFAULT
Enqueues are to be returned by the INQUIRE UOWENQ command. The default NQ domain interpreter will be called to perform the interpretation. This will map the outputs of the INQUIRE UOWENQ command as follows:
TYPE
Will be the CVDA corresponding to the ENQUEUE_TYPE parameter supplied on this call.
RESOURCE
Will be ENQUEUE_NAME1 as supplied on the NQED_ENQUEUE function.
QUALIFIER
Will be ENQUEUE_NAME2 if supplied on the NQED_ENQUEUE function. If not then no QUALIFIER data will be returned.
OWN
Enqueues are to be returned by the INQUIRE UOWENQ command. A routine provided by the pool owner will perform the interpretation. In this case the entry point of the routine must be passed in the INTERPRETER_ADDR parameter.
Note: The routine will be called by a kernel subroutine call, not by a domain call. Consequently it will execute in the domain of the caller (i.e. AP domain).
Values for the parameter are:
  • DEFAULT
  • NONE
  • OWN
EXPECTED_NAME_LENGTH
The expected length for enqueue names in the pool.
  • For pools with fixed length enqueue names this should be the length of the names that are going to be enqueued upon.
  • For pools that are to contain variable length enqueue names this should be a length that would satisfy most of the requests to be made in the pool.
Note that there is no maximum length for enqueue names. However, requests will only be handled inline if the length of the enqueue name is less than or equal to the EXPECTED_NAME_LENGTH. The inline macro only copes with names of less than or equal to 256 characters. For this reason an error will be diagnosed if a value of greater than 256 is specified for this parameter.
POOL_NAME
The eight character name of the new enqueue pool.
SHUNT_ACTION

Indicates the default action that is to be performed to UOW lifetime enqueues in this pool if their owning UOW is shunted. Note that most enqueue pools will require the same action to be performed for all enqueues in that pool. However, the ENQUEUE function allows this default to be overridden for particular enqueue requests.

The possible values are as follows:
RELEASE
The enqueue(s) will be released if the owning UOW is shunted.
RETAIN
The enqueue(s) will be retained if the owning UOW is shunted.
IGNORE
The shunt will be ignored. The enqueue(s) will remain in the same state as currently held in.
Transaction lifetime enqueues are automatically released when a shunt occurs.
Values for the parameter are:
  • IGNORE
  • RELEASE
  • RETAIN
ENQUEUE_TYPE
Optional Parameter
The enqueue type that is to be returned by the default interpreter. Should only be supplied for pools which specify a value of DEFAULT for the EXEC_INTERPRETER parameter. The possible 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
OWN_INTERPRETER_ADDRESS
Optional Parameter
Entry point of interpreter routine for this pool. Should only be supplied for pools which specify a value of OWN for the EXEC_INTERPRETER parameter.

Output Parameters

REASON
The values for the parameter are:
  • DUPLICATE_POOL_NAME
  • ENQUEUE_TYPE_EXPECTED
  • INTERPRETER_ADDR_EXPECTED
  • INVALID_NAME_LENGTH
POOL_TOKEN
Token returned which identifies the newly created enqueue pool.
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.


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