Lock manager domain’s specific gate

Table 67 summarizes the lock manager domain’s specific gate. It shows the level-1 trace point IDs of the modules providing the functions for the gate, the functions provided by the gate, and whether or not the functions are available through the exit programming interface (XPI).

Table 67. Lock manager domain’s specific gate
Gate Trace Function XPI
LMLM
LM 0003
LM 0004
ADD_LOCK
DELETE_LOCK
LOCK
UNLOCK
TEST_LOCK_OWNER
NO
NO
NO
NO
NO

LMLM gate, ADD_LOCK function

The ADD_LOCK function of the LMLM gate is used to add a named lock to LM’s state.

Input parameters

LOCK_NAME
is an 8-character name.

Output parameters

LOCK_TOKEN
is the 8-character token that uniquely identifies the lock, returned to the caller on the this call.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|INVALID|DISASTER|KERNERROR
[REASON]
is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE Possible REASON values
DISASTER
INSUFFICIENT_STORAGE
ABEND
LOOP

LMLM gate, LOCK function

The LOCK function of the LMLM gate is used to request the lock.

Input parameters

LOCK_TOKEN
is the token returned to the caller on the ADD_LOCK call.
MODE
defines the type of lock. It can have either of these values:
EXCLUSIVE|SHARED
[WAIT]
indicates whether a task is suspended (CICS®) or a LOCK_BUSY is to be returned as a reason output parameter (NO). It can have either of these values:
CICS|NO

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|PURGED|INVALID|DISASTER|KERNERROR
[REASON]
is returned when RESPONSE is DISASTER or EXCEPTION. Possible values are:
RESPONSE Possible REASON values
DISASTER
INSUFFICIENT_STORAGE
ABEND
LOOP
EXCEPTION
LOCK_TOKEN_NOT_FOUND
DUPLICATE_LOCK_OWNER
LOCK_BUSY
Note:
DUPLICATE_LOCK_OWNER is returned when a resource requests a lock twice without unlocking during the same task: this is often treated in the same way as OK by the requesting resource.

LMLM gate, UNLOCK function

The UNLOCK function of the LMLM gate is used to release the lock.

Input parameters

LOCK_TOKEN
is the token returned to the caller on the ADD_LOCK call.
MODE
defines the type of lock to be released. It can have either of these values:
EXCLUSIVE|SHARED
[OWNER_TOKEN]
defines the owner of the lock.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR
[REASON]
is returned when RESPONSE is DISASTER or EXCEPTION. Possible values are:
RESPONSE Possible REASON values
DISASTER
ABEND
LOOP
EXCEPTION
LOCK_TOKEN_NOT_FOUND
SHARED_LOCK_FREE
NOT_LOCK_OWNER

LMLM gate, TEST_LOCK_OWNER function

The TEST_LOCK_OWNER function of the LMLM gate is used to test the owner of a lock for self.

Input parameters

LOCK_TOKEN
is the token returned to the caller on the ADD_LOCK call.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR
[REASON]
is returned when RESPONSE is DISASTER or EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
LOCK_TOKEN_NOT_FOUND
NOT_LOCK_OWNER
DISASTER
ABEND
LOOP

LMLM gate, DELETE_LOCK function

The DELETE_LOCK function of the LMLM gate is used to delete the named lock from LM’s state.

Input parameters

LOCK_TOKEN
is the token returned to the caller on the ADD_LOCK call.
[OWNER_TOKEN]
defines the owner of the lock.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR
[REASON]
is returned when RESPONSE is DISASTER or EXCEPTION. Possible values are:
RESPONSE Possible REASON values
DISASTER
ABEND
LOOP
EXCEPTION
LOCK_TOKEN_NOT_FOUND
NOT_LOCK_OWNER
[[ Contents Previous Page | Next Page Index ]]