Table 41 summarizes the domain manager domain’s specific gates. It shows the level-1 trace point IDs of the modules providing the functions for the gates, the functions provided by the gates, and whether or not the functions are available through the exit programming interface (XPI).
Gate | Trace | Function | XPI |
---|---|---|---|
DMDM |
DM 0001 DM 0002 |
ADD_DOMAIN QUIESCE_SYSTEM SET_PHASE WAIT_PHASE |
NO NO NO NO |
DMIQ |
DM 0003 DM 0004 |
START_BROWSE GET_NEXT END_BROWSE INQ_DOMAIN_BY_NAME INQ_DOMAIN_BY_TOKEN INQ_DOMAIN_BY_ID |
NO NO NO NO NO NO |
DMEN |
DM 0210 DM 0211 |
LISTEN DELETE NOTIFY_SMSVSAM_OPERATIONAL |
NO NO NO |
The LISTEN function of the DMEN gate is issued to register an interest in an event notification facility (ENF) event. The MVS™ event notification facility is a generalized communication facility which allows subsystems to broadcast notification of events.
If a domain wishes to be notified of particular ENF events, it must register the events that it wishes to be notified of with Domain Manager using the LISTEN interface.
When an ENF event occurs domain manager will invoke the named listen gate of all domains that registered for that event.
SMSVSAM_OPERATIONAL
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|
PURGED
RESPONSE | Possible REASON values |
---|---|
EXCEPTION |
UNKNOWN_EVENT DUPLICATE_LISTEN |
The DELETE function of the DMEN gate is used to deregister an interest in an ENF event.
If a domain is registered with domain manager for notification of an ENF event and that domain no longer wishes to receive notification of that event then it can deregister its interest in the event using the DELETE interface.
SMSVSAM_OPERATIONAL
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|
PURGED
RESPONSE | Possible REASON values |
---|---|
EXCEPTION | LISTEN_NOT_ACTIVE |
Domains that have registered their interest in ENF events are invoked at their identified listen gates when the ENF event occurs. A unique DMEN notify function is provided for each event to allow event specific parameters to be specified in a meaningful way.
The NOTIFY_SMSVSAM_OPERATIONAL function of the DMEN gate is used to notify domains which have registered an interest in it of the occurrence of the SMSVSAM operational event.
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|
PURGED
RESPONSE | Possible REASON values |
---|---|
EXCEPTION | RESTART_RLS_FAILED |
The ADD_DOMAIN function of the DMDM gate adds a new domain to the DM table (on the CICS® catalog) of all domains. Because the add is placed on the catalog, it survives system failure. A delete is required to remove the entry.
OK|EXCEPTION|INVALID|KERNERROR|DISASTER
RESPONSE | Possible REASON values |
---|---|
DISASTER | LOADER_ERROR, ABEND, LOOP |
EXCEPTION |
DUPLICATE_DOMAIN_NAME PROGRAM_NOT_FOUND INSUFFICIENT_STORAGE DUPLICATE_DOMAIN_TOKEN |
The QUIESCE_SYSTEM function of the DMDM gate is used to call the domain manager to cause a normal shutdown of the system.
None.
OK|INVALID|KERNERROR|DISASTER
RESPONSE | Possible REASON values |
---|---|
DISASTER |
INSUFFICIENT_STORAGE ABEND LOOP |
INVALID | SYSTEM_INITIALIZING |
When a domain issues SET_PHASE during initialization, it is declaring that it is now prepared to support a given set of services.
When a domain issues SET_PHASE during quiesce, it is asserting that it still needs the set of services identified by that phase number.
The system phase is the minimum of all active domains’ phases during initialization, and the maximum during quiesce.
OK|INVALID|KERNERROR|DISASTER
RESPONSE | Possible REASON values |
---|---|
DISASTER |
ABEND LOOP |
INVALID |
SYSTEM_NOT_INITIALIZING SYSTEM_NOT_QUIESCING INVALID_PHASE |
The WAIT_PHASE function of the DMDM gate is used to wait until the services required to carry on the work are available.
A WAIT_PHASE for a given phase is understood by CICS as a SET_PHASE for at least the phase specified in the phase parameter of WAIT_PHASE.
OK|EXCEPTION|INVALID|KERNERROR|DISASTER
RESPONSE | Possible REASON values |
---|---|
DISASTER |
ABEND LOOP |
EXCEPTION | DOMAIN_TOKEN_NOT_ACTIVE |
INVALID |
SYSTEM_NOT_INITIALIZING SYSTEM_NOT_QUIESCING INVALID_PHASE |
The START_BROWSE function of the DMIQ gate is used to create a browse thread. The GET_NEXT function request issued after this command returns the first domain in the active domain list.
None.
OK|INVALID|KERNERROR|DISASTER
RESPONSE | Possible REASON values |
---|---|
DISASTER |
ABEND LOOP |
The GET_NEXT function of the DMIQ gate is used to return the next available record or an END indication.
OK|EXCEPTION|INVALID|KERNERROR|DISASTER
RESPONSE | Possible REASON values |
---|---|
DISASTER |
ABEND LOOP |
EXCEPTION | END_LIST |
INVALID | BROWSE_TOKEN_NOT_FOUND |
The END_BROWSE function of the DMIQ gate is used to release the browse thread at any time.
OK|INVALID|KERNERROR|DISASTER
RESPONSE | Possible REASON values |
---|---|
DISASTER |
ABEND LOOP |
INVALID | BROWSE_TOKEN_NOT_FOUND |
The INQ_DOMAIN_BY_NAME function of the DMIQ gate is used to get the domain’s token, ID, status, and phase for the specified domain name.
OK|INVALID|KERNERROR|DISASTER
RESPONSE | Possible REASON values |
---|---|
DISASTER |
ABEND LOOP |
INVALID | DOMAIN_NAME_NOT_FOUND |
The INQ_DOMAIN_BY_TOKEN function of the DMIQ gate is used to get the domain’s name, ID, status, and phase for the specified domain token.
OK|INVALID|KERNERROR|DISASTER
RESPONSE | Possible REASON values |
---|---|
DISASTER |
ABEND LOOP |
INVALID | DOMAIN_TOKEN_NOT_FOUND |
The INQ_DOMAIN_BY_ID function of the DMIQ gate is used to get the domain’s token, name, status, and phase for the specified domain ID.
OK|INVALID|KERNERROR|DISASTER
RESPONSE | Possible REASON values |
---|---|
DISASTER |
ABEND LOOP |
INVALID | DOMAIN_ID_NOT_FOUND |