Recovery Manager Domain’s specific gates

Table 85 summarizes the Recovery Manager domain’s specific gates. 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 85. Recovery Manager domain’s specific gate
Gate Trace Function XPI
RMUW
RM 0201
RM 0202
CREATE_UOW
INQUIRE_UOW_ID
INQUIRE_UOW_TOKEN
INQUIRE_UOW
SET_UOW
COMMIT_UOW
FORCE_UOW
START_UOW_BROWSE
GET_NEXT_UOW
END_UOW_BROWSE
BACKOUT_UOW
BIND_UOW_TO_TXN
REATTACH_REPLY
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
RMLN
RM 0301
RM 0302
ADD_LINK
DELETE_LINK
INQUIRE_LINK
SET_LINK
ISSUE_PREPARE
INBOUND_FLOW
INITIATE_RECOVERY
SET_RECOVERY_STATUS
REPORT_RECOVERY_STATUS
TERMINATE_RECOVERY
SET_MARK
START_LINK_BROWSE
GET_NEXT_LINK
END_LINK_BROWSE
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
RMNM
RM 0161
RM 0162
INQUIRE_LOGNAME
SET_LOGNAME
CLEAR_PENDING
NO
NO
NO
RMCD
RM 0121
RM 0122
REGISTER
SET_GATE
INQUIRE_CLIENT_DATA
SET_CLIENT_DATA
NO
NO
NO
NO
RMDM
RM 0101
RM 0102
INQUIRE_STARTUP
SET_STARTUP
SET_LOCAL_LU_NAME
SET_PARAMETERS
NO
NO
NO
NO
RMKD
RM 0231
RM 0232
KEYPOINT_DATA
NO
RMRE
RM 0231
RM 0232
APPEND
FORCE
REMOVE
AVAIL
REQUEST_FORGET
NO
NO
NO
NO
NO
RMSL
RM 06E1
RM 06E2
TAKE_ACTIVITY_KEYPOINT
NO
RMWT
RM 0201
RM 0202
INQUIRE_WORK_TOKEN
SET_WORK_TOKEN
START_WORK_TOKEN_BROWSE
GET_NEXT_WORK_TOKEN
END_WORK_TOKEN_BROWSE
NO
NO
NO
NO
NO

RMUW gate, CREATE_UOW function

Create a unit of work object under the currently executing transaction.

Input parameters

UOW_ID
An optional parameter specifying the network UOWID to be given to the unit of work object. This parameter will be present if the unit of work being created is part of a distributed unit of work that originated on another system.
HEURISM
An optional parameter specifying whether the unit of work should take a unilateral decision if a failure occurs in the in doubt window? It can have any one of these values:
YES|NO
CHOICE
An optional parameter specifying whether the unit of work should commit or backout if requested to take a unilateral decision. It can have any one of these values:
FORWARD|BACKWARD
INDOUBT_TIMEOUT_INTERVAL
An optional parameter specifying the period of time that the unit of work should be prepared to wait in doubt.

Output parameters

RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

RMUW gate, INQUIRE_UOW_ID function

Return the network and local UOWIDs of the unit of work of the currently executing transaction.

Input parameters

UOW_ID
An optional parameter specifying a buffer in which the network UOWID will be returned.

Output parameters

LOCAL_UOW_ID
An optional parameter to receive the local UOWID.
RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

RMUW gate, INQUIRE_UOW_TOKEN function

Return the token identifying the unit of work object with the specified local UOWID.

Input parameters

LOCAL_UOW_ID
The local UOWID of the required unit of work.

Output parameters

UOW_TOKEN
A token identifying the unit of work object.
RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION NOT_FOUND

RMUW INQUIRE_UOW function

This function is used to query information about a particular unit of work.

Input parameters

UOW_TOKEN
An optional parameter specifying a token used to identify the unit of work object being queried.
TRANSACTION_TOKEN
An optional parameter specifying a token of a transaction whose unit of work object is to be queried.
LOG_CHAIN_TOKEN
An optional parameter specifying a token of a log chain whose unit of work object is to be queried.
UOW_ID
An optional parameter specifying a buffer in which the network UOWID will be returned.
LOGNAME
An optional parameter specifying a buffer in which the log name of the coordinating system will be returned.
LOCAL_ACCESS_ID
An optional parameter specifying a buffer in which the local access id of resource causing the unit of work to shunt will be returned.
REMOTE_ACCESS_ID
An optional parameter specifying a buffer in which the netname of coordinating system will be returned.
LINK_ID
An optional parameter specifying a buffer in which the termid of the link to the coordinating system will be returned.

Output parameters

OUT_UOW_TOKEN
The token used to identify the unit of work object.
LOCAL_UOW_ID
The local unit of work id.
TRANID
The tranid of the task that created the unit of work object.
TERMID
The termid associated with the task that created the unit of work object.
TERMINAL_LUNAME
The terminal LU name associated with the task that created the unit of work object.
USERID
The userid associated with the task that created the unit of work object.
CHOICE
The choice of whether the unit of work should commit or backout if requested to take a unilateral decision. It can have any one of these values:
FORWARD|BACKWARD
UOW_STATUS
The status of the unit of work. It can have any one of these values:
FORWARD|BACKWARD|IN_DOUBT|IN_FLIGHT|
HEURISTIC_FORWARD|HEURISTIC_BACKWARD
SHUNTED
The unit of work may or may not be shunted. It can have any one of these values:
YES|NO
DURATION
An 8 byte Store Clock representation of the time the unit of work changed state.
CREATION_TIME
An 8 byte Store Clock representation of the time the unit of work was created.
CLIENT_NAME
The name of the Recovery Manager client that owns the resource that has caused the unit of work to shunt.
ACCESS_ID_TYPE
The type of resource that has caused the unit of work to shunt. It can have any one of these values:
LOCAL|REMOTE
TRANNUM
The task number of the task that created the unit of work.
OP_ID
The Operator Id associated with the task that created the unit of work.
FIRST_UOW_FOR_TXN
It can have any one of these values:
YES|NO
HEURISM
Whether the unit of work should take a unilateral decision if a failure occurs in the in doubt window? It can have any one of these values:
YES|NO
AWAITING_FORGET
The unit of work might have completed syncpoint processing, and be merely waiting for confirmation that subordinates have completed theirs. It can have any one of these values:
YES|NO
RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION NOT_FOUND

RMUW gate, SET_UOW function

This function is used to set characteristics of the currently executing unit of work.

Input parameters

HEURISM
Determines whether the unit of work will take a unilateral decision if a failure occurs in the in doubt window, or waits for communication with the coordinating system to be reestablished. It can have any one of these values:
YES|NO
HEURISTIC_CAUSE
An indication of the reason a unilateral decision must be taken. It can have any one of these values:
TD_CLIENT|LU61_CLIENT|MRO_CLIENT|
RMI_CLIENT|OTHER_CLIENT

Output parameters

USERID
When requested this parameter causes the userid associated with unit of work to be reset to that of the currently executing transaction.
RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION NOT_FOUND

RMUW gate, COMMIT_UOW function

This function attempts to commit the changes made in a unit of work.

Input parameters

CONTINUE
Is the task continuing into a following, new unit of work. This parameter can have any one of these values:
YES|NO

Output parameters

RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
ROLLBACK,
LOCAL_NO_VOTE,
REMOTE_NO_VOTE,
REMOTE_NO_DECISION,
HEURISTIC_READONLY_COMMIT,
HEURISTIC_READONLY_BACKOUT,
HEURISTIC_BACKOUT,
LINKS_INVALID,
HEURISTIC_COMMIT,
INDOUBT_FAILURE,
COMMIT_FAILURE,
REMOTE_COMMIT_ABENDED

RMUW gate, FORCE_UOW function

This function forces an in doubt unit of work to unilaterally commit or backout its changes rather than continue waiting for resynchronization with the coordinating system.

Input parameters

UOW_TOKEN
The token identifying the unit of work object.
DIRECTION
Parameter specifying whether to commit (FORWARD), backout (BACKWARD) or obey the ACTION attribute in the definition of the originating transaction. It can have any one of these values:
FORWARD|BACKWARD|HEURISTIC
HEURISTIC_CAUSE
The reason for the force. It can have any one of these values:
OPERATOR|TIMEOUT|OTHER_CAUSE

Output parameters

RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
NOT_FOUND,
RESYNCH_IN_PROGRESS,
UOW_NOT_INDOUBT

RMUW gate, START_UOW_BROWSE function

This function is used to start a browse of unit of work objects in the system.

Input parameters

SHUNTED
The browse can be of only shunted units of work, only non-shunted units of work or all units of work. This parameter can have any one of these values:
YES|NO|BOTH

Output parameters

BROWSE_TOKEN
A token to be used on subsequent GET_NEXT_UOW calls.
RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION NOT_FOUND

RMUW gate, GET_NEXT_UOW function

This function returns information about the next unit of work object in the browse.

Input parameters

BROWSE_TOKEN
A token obtained from a previous START_UOW_BROWSE call.
UOW_ID
An optional parameter specifying a buffer in which the network UOWID will be returned.
LOGNAME
An optional parameter specifying a buffer in which the log name of the coordinating system will be returned.
LOCAL_ACCESS_ID
An optional parameter specifying a buffer in which the local access id of resource causing the unit of work to shunt will be returned.
REMOTE_ACCESS_ID
An optional parameter specifying a buffer in which the netname of coordinating system will be returned.
LINK_ID
An optional parameter specifying a buffer in which the termid of the link to the coordinating system will be returned.

Output parameters

OUT_UOW_TOKEN
The token used to identify the unit of work object.
LOCAL_UOW_ID
The local unit of work id.
TRANID
The tranid of the task that created the unit of work object.
TERMID
The termid associated with the task that created the unit of work object.
TERMINAL_LUNAME
The terminal LU name associated with the task that created the unit of work object.
USERID
The userid associated with the task that created the unit of work object.
CHOICE
The choice of whether the unit of work should commit or backout if requested to take a unilateral decision. It can have any one of these values:
FORWARD|BACKWARD
UOW_STATUS
The status of the unit of work. It can have any one of these values:
FORWARD|BACKWARD|IN_DOUBT|IN_FLIGHT|
HEURISTIC_FORWARD|HEURISTIC_BACKWARD
SHUNTED
The unit of work may or may not be shunted. It can have any one of these values:
YES|NO
DURATION
An 8 byte Store Clock representation of the time the unit of work changed state.
CREATION_TIME
An 8 byte Store Clock representation of the time the unit of work was created.
CLIENT_NAME
The name of the Recovery Manager client that owns the resource that has caused the unit of work to shunt.
ACCESS_ID_TYPE
The type of resource that has caused the unit of work to shunt. It can have any one of these values:
LOCAL|REMOTE
TRANNUM
The task number of the task that created the unit of work.
OP_ID
The Operator Id associated with the task that created the unit of work.
FIRST_UOW_FOR_TXN
It can have any one of these values:
YES|NO
HEURISM
Whether the unit of work should take a unilateral decision if a failure occurs in the in doubt window? It can have any one of these values:
YES|NO
AWAITING_FORGET
The unit of work might have completed syncpoint processing, and be merely waiting for confirmation that subordinates have completed theirs. It can have any one of these values:
YES|NO
RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
INVALID_BROWSE_TOKEN,
BROWSE_END

RMUW gate, END_UOW_BROWSE function

This function is used at the end of a browse of the unit of work objects in the system.

Input parameters

BROWSE_TOKEN
A token obtained from a previous START_UOW_BROWSE call.

Output parameters

RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION INVALID_BROWSE_TOKEN

RMUW gate, BACKOUT_UOW function

This function causes the changes in a unit of work to be backed out.

Input parameters

CONTINUE
This parameter indicates whether the task is continuing into a following, new unit of work. This parameter can have any one of these values:
YES|NO
RESTART
This parameter is only applicable when CONTINUE(NO) is specified and indicates whether or not transaction restart will be performed.

Output parameters

RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
BACKOUT_FAILURE,
COMMIT_FAILURE,
ROLLBACK_NOT_SUPPORTED,
REMOTE_COMMIT_ABENDED

RMUW gate, BIND_UOW_TO_TXN function

Make the specified unit of work the current unit of work for the current transaction.

Input parameters

UOW_TOKEN
The token identifying the unit of work object.

Output parameters

RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

RMUW gate, REATTACH_REPLY function

This function gives control to Recovery Manager to do its unshunt processing under a re-attached transaction.

Input parameters

UOW_TOKEN
The token identifying the unit of work object.

Output parameters

RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

RMLN gate, ADD_LINK function

This function adds a link to a remote system to a unit of work. The unit of work is distributed across more than one system and Recovery Manager will manage the syncpoint processing between systems.

Input parameters

CLIENT_NAME
Name of the communications protocol used on the link. It can have any one of these values:
IRC |IRCO|LU61|LU62|RMI |IND
LOGNAME_BUFFER
An optional parameter specifying a buffer containing the logname of the remote system.
REMOTE_ACCESS_ID_BUFFER
A buffer containing the netname of the remote system, or the name of the External Resource Manager.
LINK_ID_BUFFER
A buffer containing the termid of the session to the remote system, or the External Resource Manager qualifier.
LINK_ID_SOURCE
An optional parameter specifying whether the local or remote system allocated the session. It can have any one of these values:
LOCAL|REMOTE
RMC_TOKEN
A token to be passed to the client on all callback functions.
LAST
A parameter specifying whether the remote system supports the last agent optimization. It can have any one of these values:
YES|NO|MAYBE|DESIRABLE
PRESUMPTION
A parameter specifying whether the remote system assumes the presume abort or presume nothing protocols. It can have any one of these values:
ABORT|NOTHING
PRELOGGING
A parameter specifying whether the client requires to be called with the PERFORM_PRELOGGING callback function. It can have any one of these values:
YES|NO
SINGLE_UPDATER
A parameter specifying whether the remote system supports the single updater optimization. It can have any one of these values:
YES|NO
COORDINATOR
A parameter specifying whether the remote system is the coordinator of the distributed unit of work. It can have any one of these values:
YES|NO
INITIATOR
A parameter specifying whether the remote system is the initiator of the syncpoint. It can have any one of these values:
YES|NO
RECOVERY_STATUS
A parameter specifying whether recoverable work has taken place as part of the distributed unit of work on the remote system. It can have any one of these values:
NECESSARY|UNNECESSARY|SYNC_LEVEL_1

Output parameters

LINK_TOKEN
A token identifying the new Recovery Manager Link object.
RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
CLIENT_UNKNOWN,
COORDINATOR_ALREADY

RMLN gate, DELETE_LINK function

This function removes a link to a remote system from a unit of work. The remote system will not now be included in syncpoint processing for the current unit of work.

Input parameters

LINK_TOKEN
A token identifying the Recovery Manager Link object.

Output parameters

RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION LINK_UNKNOWN

RMLN gate, INQUIRE_LINK function

This function returns information about a given Recovery Manager Link object.

Input parameters

LINK_TOKEN
A token identifying a Recovery Manager Link object.
RESOLVE_TO_CURRENT_LINK
Up to two Recovery Manager Link objects may be associated with a token. This optional parameter specifies whether to return information about the most recent or not. It can have any one of these values:
YES|NO
REMOTE_ACCESS_ID_BUFFER
A buffer in which the netname of the remote system, or External Resource Manager name will be returned.
LOGNAME_BUFFER
A buffer in which the logname of the remote system will be returned.
LINK_ID_BUFFER
A buffer in which the termid of the session to the remote system, or External Resource Manager qualifier will be returned.

Output parameters

CLIENT_NAME
The name of the protocol that owns the Recovery Manager Link object. It can have any one of these values:
IRC |IRCO|LU61|LU62|RMI |IND
COORDINATOR
Whether the remote system is the coordinator of the distributed unit of work. It can have any one of these values:
YES|NO
INITIATOR
Whether the remote system is the initiator of the syncpoint of the distributed unit of work. It can have any one of these values:
YES|NO
LAST
Whether the remote system supports the last agent optimization. It can have any one of these values:
YES|NO|MAYBE
SINGLE_UPDATER
Whether the remote system supports the single updater optimization. It can have any one of these values:
YES|NO
PRESUMPTION
Whether the remote system assumes the presume abort or presume nothing protocols. It can have any one of these values:
ABORT|NOTHING
RECOVERY_STATUS
Whether recoverable work has taken place as part of the distributed unit of work on the remote system. It can have any one of these values:
NECESSARY|UNNECESSARY|SYNC_LEVEL_1
FORGET
Whether all obligations to the remote system with respect to recovery have been discharged. It can have any one of these values:
YES|NO
MARK
Whether the Recovery Manager Link object has been marked during resynchronization. It can have any one of these values:
YES|NO
UNSHUNTED
Whether the unit of work is not currently shunted. It can have any one of these values:
YES|NO
RESYNC_SCHEDULED
Whether resynchronization activity has been scheduled. It can have any one of these values:
YES|NO
ACCESSIBLE
Whether the communications link to the remote system is active or not. It can have any one of these values:
YES|NO|SHUNTED
LINK_ID_SOURCE
Whether the local or remote system allocated the session. It can have any one of these values:
LOCAL|REMOTE
UOW_TOKEN
The token identifying the unit of work object.
LOCAL_UOW_ID
The local unit of work id of the unit of work to which the Recovery Manager Link object belongs.
HEURISM
Whether the unit of work to which the Recovery Manager Link object belongs will take a unilateral decision if a failure occurs in the in doubt window. It can have any one of these values:
YES|NO
RMC_TOKEN
A token to be passed to the client on all callback functions.
RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION LINK_UNKNOWN

RMLN gate, SET_LINK function

This function is used to set characteristics of a Recovery Manager Link object.

Input parameters

LINK_TOKEN
A token used to identify a Recovery Manager Link object.
RESOLVE_TO_CURRENT_LINK
Up to two Recovery Manager Link objects may be associated with a token. This optional parameter specifies whether to set characteristics of the most recent or not. It can have any one of these values:
YES|NO
LOGNAME_BUFFER
An optional parameter specifying a buffer containing a logname to be associated with the Recovery Manager Link object.
COORDINATOR
A parameter specifying whether the remote system is the coordinator of the distributed unit of work. It can have any one of these values:
YES|NO
INITIATOR
A parameter specifying whether the remote system is the initiator of the syncpoint. It can have any one of these values:
YES|NO
RECOVERY_STATUS
A parameter specifying whether recoverable work has taken place as part of the distributed unit of work on the remote system. It can have any one of these values:
NECESSARY|UNNECESSARY|SYNC_LEVEL_1
SINGLE_UPDATER
A parameter specifying whether the remote system supports the single updater optimization. It can have any one of these values:
YES|NO
PRELOGGING
A parameter specifying whether the client requires to be called with the PERFORM_PRELOGGING callback function. It can have any one of these values:
YES|NO
LINK_ID_BUFFER
A buffer containing the termid of the session to the remote system, or the External Resource Manager qualifier.
LINK_ID_SOURCE
An optional parameter specifying whether the local or remote system allocated the session. It can have any one of these values:
LOCAL|REMOTE
UNSHUNTED
A parameter specifying whether the unit of work is not currently shunted. It can have any one of these values:
YES|NO
RESYNC_SCHEDULED
A parameter specifying whether resynchronization activity has been scheduled. It can have any one of these values:
YES|NO
ACCESSIBLE
A parameter specifying that the communications link to the remote system has failed. It can have any one of these values:
NO|SHUNTED
FORGET
A parameter specifying whether all obligations to the remote system with respect to recovery have been discharged. It can have any one of these values:
YES|NO

Output parameters

RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
LINK_UNKNOWN,
COORDINATOR_ALREADY,
INITIATOR_ALREADY

RMLN gate, ISSUE_PREPARE function

This function performs phase 1 of syncpoint processing on the specified Recovery Manager Link object.

Input parameters

LINK_TOKEN
A token used to identify a Recovery Manager Link object.
CONTINUE
Is the task continuing into a following, new unit of work. This parameter can have any one of these values:
YES|NO

Output parameters

VOTE
The vote from the client owning the Recovery Manager Link object. This parameter can have any one of these values:
YES|NO|NO_CONTINUE|READ_ONLY
RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
LINK_UNKNOWN,
COORDINATOR_ALREADY,
INITIATOR_ALREADY,
PREPARE_REJECTED

RMLN gate, INBOUND_FLOW function

This function is used to notify Recovery Manager of the successful completion of syncpoint processing on the remote system, or a communications failure with the remote system.

Input parameters

LINK_TOKEN
A token used to identify a Recovery Manager Link object.
FLOW
A parameter specifying successful completion (DATA) or communication failure (UNBIND). It can have any one of these values:
DATA|UNBIND

Output parameters

RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
LINK_UNKNOWN,
LINK_INACCESSIBLE

RMLN gate, INITIATE_RECOVERY function

This function identifies a Recovery Manager Link object in an in doubt failed unit of work and marks it as being resynchronized.

Input parameters

UOW_ID
An optional parameter specifying a buffer containing the network UOWID of the unit of work to be resynchronized.
LOCAL_UOW_ID
An optional parameter specifying the local UOWID.
CLIENT_NAME
The name of the Recovery Manager client that owns the Recovery Manager Link object over which resynchronization is to take place.
REMOTE_ACCESS_ID_BUFFER
A buffer containing the netname of the remote system, or the name of the External Resource Manager of the Recovery Manager Link object over which resynchronization is to take place.
LINK_ID_BUFFER
A buffer containing the termid of the session to the remote system, or the External Resource Manager qualifier of the Recovery Manager Link object over which resynchronization is to take place.
LINK_ID_SOURCE
An optional parameter specifying whether the local or remote system allocated the session associated with the Recovery Manager Link object over which resynchronization is to take place. It can have any one of these values:
LOCAL|REMOTE
DIRECTION
A parameter specifying whether the resynchronization activity was initiated by the local or remote system. It can have any one of these values:
INBOUND|OUTBOUND

Output parameters

UOW_TOKEN
The token identifying the unit of work object. to which the Recovery Manager Link object being resynchronized belongs.
LINK_TOKEN
A token identifying the Recovery Manager Link object being resynchronized.
COORDINATOR
A parameter specifying whether the remote system is the coordinator of the distributed unit of work. It can have any one of these values:
YES|NO
INITIATOR
A parameter specifying whether the remote system is the initiator of the syncpoint. It can have any one of these values:
YES|NO
PRESUMPTION
Whether the remote system assumes the presume abort or presume nothing protocols. It can have any one of these values:
ABORT|NOTHING
UOW_STATUS
The status of the unit of work object that the Recovery Manager Link object belongs to. It can have any one of these values:
INDOUBT|FORWARD|BACKWARD|
HEURISTIC_FORWARD|HEURISTIC_BACKWARD
FAILURE_TIME
An 8 byte Store Clock representation of the in doubt failure time.
RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
LINK_UNKNOWN,
RECOVERY_ALREADY_IN_PROG,
LINK_ACTIVE

RMLN gate, SET_RECOVERY_STATUS function

This function is used to notify an Recovery Manager Link object of the outcome of a distributed unit of work which failed in the in doubt window. It results in the shunted unit of work the Recovery Manager Link object belongs to unshunting and committing or backing out its resource updates as appropriate.

Input parameters

LINK_TOKEN
A token identifying the Recovery Manager Link object being resynchronized.
DIRECTION
A parameter specifying whether the resynchronization activity was initiated by the local or remote system. It can have any one of these values:
INBOUND|OUTBOUND
REMOTE_UOW_STATUS
The status of the unit of work in the remote system. It can have any one of these values:
INDOUBT|HEURISTIC_FORWARD|HEURISTIC_BACKWARD|
FORWARD|BACKWARD|HEURISTIC_MIXED|COLD|RESET|UNKNOWN
TOLERATE_VIOLATIONS
A parameter specifying the rules to be used to detect resynchronization protocol violations. It can have any one of these values:
YES|NO

Output parameters

UOW_STATUS
The status (as a result of the resynchronization) of the unit of work object to which the Recovery Manager Link object belongs. It can have any one of these values:
INDOUBT|HEURISTIC_FORWARD|HEURISTIC_BACKWARD|
FORWARD|BACKWARD
RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
LINK_UNKNOWN,
RECOVERY_NOT_IN_PROGRESS,
ALREADY_SET

RMLN gate, REPORT_RECOVERY_STATUS function

This function is similar to SET_RECOVERY_STATUS but is applicable in the case of Presumed Abort or Last Agent resynchronization where the coordinator has backed out and has no record of the UOW. The participant may have gone indoubt, and needs to resynchronize.

Input parameters

UOW_ID
A parameter specifying a buffer containing the network UOWID of the unit of work to be resynchronized.
REMOTE_ACCESS_ID_BUFFER
A buffer containing the netname of the remote system, or the name of the External Resource Manager of the Recovery Manager Link object over which resynchronization is to take place.
REMOTE_UOW_STATUS
The status of the unit of work in the remote system. It can have any one of these values:
INDOUBT|HEURISTIC_FORWARD|HEURISTIC_BACKWARD|
HEURISTIC_MIXED

Output parameters

RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

RMLN gate, TERMINATE_RECOVERY function

Input parameters

LINK_TOKEN
A token identifying the Recovery Manager Link object being resynchronized.
DIRECTION
A parameter specifying whether the resynchronization activity was initiated by the local or remote system. It can have any one of these values:
INBOUND|OUTBOUND
FORGET
A parameter specifying whether all obligations to the remote system with respect to recovery have been discharged. It can have any one of these values:
YES|NO
OPERATOR_INITIATED
A parameter specifying whether the function is the result of an explicit user action. It can have any one of these values:
YES|NO

Output parameters

RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
LINK_UNKNOWN,
RECOVERY_NOT_IN_PROGRESS,
SET_NOT_DONE

RMLN gate, SET_MARK function

This function marks a Recovery Manager Link object during recovery.

Input parameters

LINK_TOKEN
A token identifying the Recovery Manager Link object to be marked.
MARK
It can have any one of these values:
YES|NO

Output parameters

RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
LINK_UNKNOWN,
LINK_ACTIVE,
RECOVERY_IN_PROGRESS

RMLN gate, START_LINK_BROWSE function

This function starts a browse of Recovery Manager Link objects. The browse can return either

Input parameters

CLIENT_NAME
The name of a Recovery Manager client.
REMOTE_ACCESS_ID_BUFFER
A buffer containing the netname of the remote system, or the name of the External Resource Manager.
UOW_TOKEN
The token identifying a unit of work object.

Output parameters

LINK_BROWSE_TOKEN
A token to be used during a browse of all Recovery Manager Link objects for a particular Recovery Manager client.
UOW_BROWSE_TOKEN
A token to be used during a browse of all Recovery Manager Link objects for a particular unit of work object.
RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
UOW_UNKNOWN,
CLIENT_UNKNOWN

RMLN gate, GET_NEXT_LINK function

This function returns information about the next Recovery Manager Link object in a browse.

Input parameters

LINK_BROWSE_TOKEN
A token identifying a browse of all the Recovery Manager Link objects belonging to a particular Recovery Manager client.
UOW_BROWSE_TOKEN
A token identifying a browse of all the Recovery Manager Link objects belonging to a particular unit of work object.
REMOTE_ACCESS_ID_BUFFER
A buffer in which the netname of the remote system, or External Resource Manager name will be returned.
LOGNAME_BUFFER
A buffer in which the logname of the remote system will be returned.
LINK_ID_BUFFER
A buffer in which the termid of the session to the remote system, or External Resource Manager qualifier will be returned.

Output parameters

LINK_TOKEN
CLIENT_NAME
The name of the protocol that owns the Recovery Manager Link object. It can have any one of these values:
IRC |IRCO|LU61|LU62|RMI |IND
COORDINATOR
Whether the remote system is the coordinator of the distributed unit of work. It can have any one of these values:
YES|NO
INITIATOR
Whether the remote system is the initiator of the syncpoint of the distributed unit of work. It can have any one of these values:
YES|NO
LAST
Whether the remote system supports the last agent optimization. It can have any one of these values:
YES|NO|MAYBE
SINGLE_UPDATER
Whether the remote system supports the single updater optimization. It can have any one of these values:
YES|NO
PRESUMPTION
Whether the remote system assumes the presume abort or presume nothing protocols. It can have any one of these values:
ABORT|NOTHING
RECOVERY_STATUS
Whether recoverable work has taken place as part of the distributed unit of work on the remote system. It can have any one of these values:
NECESSARY|UNNECESSARY|SYNC_LEVEL_1
FORGET
Whether all obligations to the remote system with respect to recovery have been discharged. It can have any one of these values:
YES|NO
MARK
Whether the Recovery Manager Link object has been marked during resynchronization. It can have any one of these values:
YES|NO
UNSHUNTED
Whether the unit of work is not currently shunted. It can have any one of these values:
YES|NO
RESYNC_SCHEDULED
Whether resynchronization activity has been scheduled. It can have any one of these values:
YES|NO
ACCESSIBLE
Whether the communications link to the remote system is active or not. It can have any one of these values:
YES|NO|SHUNTED
LINK_ID_SOURCE
Whether the local or remote system allocated the session. It can have any one of these values:
LOCAL|REMOTE
UOW_TOKEN
The token identifying the unit of work object.
LOCAL_UOW_ID
The local unit of work id of the unit of work to which the Recovery Manager Link object belongs.
HEURISM
Whether the unit of work to which the Recovery Manager Link object belongs will take a unilateral decision if a failure occurs in the in doubt window. It can have any one of these values:
YES|NO
RMC_TOKEN
A token to be passed to the client on all callback functions.
RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
UOW_UNKNOWN,
END_BROWSE
INVALID INVALID_BROWSE

RMLN gate, END_LINK_BROWSE function

This function is used to terminate a browse of Recovery Manager Link objects.

Input parameters

LINK_BROWSE_TOKEN
A token identifying a browse of all the Recovery Manager Link objects belonging to a particular Recovery Manager client.
UOW_BROWSE_TOKEN
A token identifying a browse of all the Recovery Manager Link objects belonging to a particular unit of work object.

Output parameters

RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID. Possible values are:
RESPONSE Possible REASON values
INVALID INVALID_BROWSE

RMNM gate, INQUIRE_LOGNAME function

This function returns the logname and data associated with the specified remote system being communicated with via the specified Recovery Manager client.

Input parameters

CLIENT_NAME
Name of a Recovery Manager client.
REMOTE_ACCESS_ID_BUFFER
A buffer containing the netname of the remote system.
LOGNAME_BUFFER
A buffer to be used to return the logname.
RMC_DATA_BUFFER
A buffer to be used to return data owned by the Recovery Manager client.

Output parameters

IN_USE
Whether there are any Recovery Manager Link object in the system associated with the logname. It can have any one of these values:
YES|NO
RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
NOT_FOUND,
UNKNOWN_CLIENT

RMNM gate, SET_LOGNAME function

This function is used to associate a logname and some data with the netname of a remote system for a specified Recovery Manager client.

Input parameters

CLIENT_NAME
A name of a Recovery Manager client.
REMOTE_ACCESS_ID_BUFFER
A buffer containing the netname of a remote system.
LOGNAME_BUFFER
A buffer containing the logname to be associated with the netname.
RMC_DATA_BUFFER
A buffer containing data to be associated with the netname.

Output parameters

RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION UNKNOWN_CLIENT

RMNM gate, CLEAR_PENDING function

This function is used to remove Recovery Manager Link objects associated with a specified remote system. Affected indoubt units of work will take a unilateral decision to commit or backout their resource updates.

Input parameters

CLIENT_NAME
A name of a Recovery Manager client.
REMOTE_ACCESS_ID_BUFFER
A buffer containing the netname of the remote system.
COLD
A parameter specifying whether the remote system has a new log and so has lost recovery information with respect to units of work in this system. It can have any one of these values:
YES|NO
ALL
A parameter specifying whether only Recovery Manager Link objects with the same logname as that currently associated with the remote system should be removed or all Recovery Manager Link objects.

Output parameters

RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION NOT_FOUND

RMCD gate, REGISTER function

This function is used to register a Recovery Manager client.

Input parameters

CLIENT_NAME
A name of a Recovery Manager client.
CLIENT_TYPE
Whether the client owns local (RO) or remote (RMC) resources. It can have any one of these values:
RO|RMC
GATE
An optional parameter specifying the kernel gate that services the client's callback functions.

Output parameters

RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
ALREADY_REGISTERED,
TOO_LATE

RMCD gate, SET_GATE function

This function is used to inform Recovery Manager of the kernel gate that services a Recovery Manager clients callback functions.

Input parameters

CLIENT_NAME
A name of a Recovery Manager client.
GATE
A parameter specifying the kernel gate that services the client's callback functions.

Output parameters

RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
UNKNOWN_CLIENT,
GET_ALREADY_SET

RMCD gate, INQUIRE_CLIENT_DATA function

This function returns data associated with a Recovery Manager client.

Input parameters

CLIENT_NAME
A name of a Recovery Manager client.
CLIENT_DATA_BUFFER
A buffer to contain the data returned.

Output parameters

RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
UNKNOWN_CLIENT,
CLIENT_DATA_TOO_LONG

RMCD gate, SET_CLIENT_DATA function

This function associates some data with a Recovery Manager client.

Input parameters

CLIENT_NAME
A name of a Recovery Manager client.
CLIENT_DATA_BUFFER
A buffer containing the data to be associated with the Recovery Manager client.

Output parameters

RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
UNKNOWN_CLIENT,
CLIENT_DATA_TOO_LONG

RMDM gate, INQUIRE_STARTUP function

This function returns information about the type of system start being performed.

Input parameters

None

Output parameters

STARTUP
It can have any one of these values:
COLD|WARM|EMERGENCY
ALL
A value specifying whether all components are cold starting. It can have any one of these values:
YES|NO
INITIAL_START
A value specifying whether the cold start is in fact an initial one. It can have any one of these values:
YES|NO
LAST_COLD_START_TIME
An 8 byte Store Clock representation of the last cold start time.
LAST_EMER_START_TIME
An 8 byte Store Clock representation of the last emergency start time.
LAST_INIT_START_TIME
An 8 byte Store Clock representation of the last initial start time.
RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

RMDM gate, SET_STARTUP function

This function sets the type of start that will be performed when this system is next restarted.

Input parameters

STARTUP
The type of start. It can have any one of these values:
COLD|NORESTART

Output parameters

RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

RMDM gate, SET_LOCAL_LU_NAME function

This function sets the local LU name, that is used in the generation of network UOWIDs by in this system.

Input parameters

LOCAL_LU_NAME
A parameter specifying the local LU name.
LOCAL_LU_NAME_LENGTH
A parameter specifying the length of the local LU name.

Output parameters

RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

RMDM gate, SET_PARAMETERS function

This function is used only by Parameter Manager Domain to inform Recovery Manager of initialization parameters.

Input parameters

DELETE_LOG
An optional parameter specifying whether an initial start has been requested in the System Initialization Table, and so the contents of the system log should be deleted. It can have any one of these values:
YES|NO
STARTUP
An optional parameter used in the case where OFFSITE=YES has been specified as a SIT override. It can only have the value EMERGENCY.

Output parameters

RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

RMKD gate, KEYPOINT_DATA function

This function writes Recovery Manager client data to the system log for keypointing purposes.

Input parameters

CLIENT_NAME
A name of a Recovery Manager client.
DATA
Address of an extended Iliffe vector. An extended Iliffe vector consists of a linked list of at least one element. Each element of the linked list consists of a variable length array of address length pairs. Each address and length field is four bytes long. The top bit of each address is off except for the last which may be on.

If an address is binary zero, then this terminates the element and the linked list.

If an address has the top bit on, then it terminates the element and points to the next element in the linked list.

An extended Iliffe vector simply represents the block of data formed by concatenating all the blocks which are pointed to by address length pairs in the vector which have the address top bit off. The order is from front to back of the linked list and from low to high index within each array.

REMARK
An optional parameter for the benefit of trace to describe the data being logged.
RAISE_INV_DATA_LENGTH
An optional parameter specifying whether the caller wishes to be informed of there being to much data to be logged. It can have any one of these values:
YES|NO

Output parameters

RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
INVALID_DATA_LENGTH,
INVALID_CLIENT_NAME,
NO_DATA

RMRE gate, APPEND function

This function writes data to the system log. The data written is associated with the current unit of work of the currently executing transaction if either FORWARD_DATA(YES) or BACKWARD_DATA(YES) is specified.

Input parameters

CLIENT_NAME
A name of a Recovery Manager client.
RESOURCE_ID
A parameter specifying the name of the resource with which the data to be logged is associated.
DATA
Address of an extended Iliffe vector. An extended Iliffe vector consists of a linked list of at least one element. Each element of the linked list consists of a variable length array of address length pairs. Each address and length field is four bytes long. The top bit of each address is off except for the last which may be on.

If an address is binary zero, then this terminates the element and the linked list.

If an address has the top bit on, then it terminates the element and points to the next element in the linked list.

An extended Iliffe vector simply represents the block of data formed by concatenating all the blocks which are pointed to by address length pairs in the vector which have the address top bit off. The order is from front to back of the linked list and from low to high index within each array.

FORCE_DATA
A parameter specifying whether the data is forced out on to the non-volatile log or can merely be written to the volatile log buffer. It can have any one of these values:
YES|NO
FORWARD_DATA
A parameter specifying whether the data is used for forward recovery purposes. It can have any one of these values:
YES|NO
BACKWARD_DATA
A parameter specifying whether the data is used for backward recovery purposes. It can have any one of these values:
YES|NO
REMARK
An optional parameter for the benefit of trace to describe the data being logged.
LOG_BUFFER_SUSPEND
An optional parameter specifying whether the caller can tolerate the task suspending to wait for space in a log buffer. It can have any one of these values:
YES|NO
RAISE_INV_DATA_LENGTH
An optional parameter specifying whether the caller wishes to be informed of there being to much data to be logged. It can have any one of these values:
YES|NO

Output parameters

FORCE_TOKEN
A token that can be used to force the data on to the non-volatile log with the FORCE function of the RMRE gate.
RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
INVALID_DATA_LENGTH,
INSUFFICIENT_BUFFER_SPACE,
INVALID_CLIENT_NAME,
INVALID_RESOURCE_ID,
NO_DATA

RMRE gate, FORCE function

This function forces data written previously to a log buffer to the non-volatile log.

Input parameters

FORCE_TOKEN
A token returned on a previous call to the APPEND function of the RMRE gate.

Output parameters

RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

RMRE gate, REMOVE function

This function removes data logged by a Recovery Manager client and associated with a particular local resource from a unit of work.

Input parameters

UOW_ID
The network UOWID under which the data was logged.
LOCAL_UOW_ID
The local UOWID under which the data was logged.
CLIENT_NAME
The name of the Recovery Manager client that logged the data.
LOCAL_ACCESS_ID
The name of the local resource with which the logged data was associated.

Output parameters

RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
UOW_NOT_SHUNTED,
UOW_NOT_BACKWARDS,
INVALID_CLIENT_NAME,
INVALID_LOCAL_ACCESS_ID

RMRE gate, AVAIL function

This function informs Recovery Manager that a local resource has become available. It is used when either a backout failure or a commit failure has previously occurred and the resource (or reason for the failure) has now cleared - or there is now reason to believe it may have cleared.

Input parameters

CLIENT_NAME
The name of the Recovery Manager client that owns the local resource.
LOCAL_ACCESS_ID
The name of the local resource.

Output parameters

RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION LOCAL_ACCESS_ID_UNKNOWN

RMRE gate, REQUEST_FORGET function

This function associates a Recovery Manager client and a named local resource with a requirement to engage in forget processing.

Input parameters

CLIENT_NAME
The name of the Recovery Manager client that owns the local resource.
LOCAL_ACCESS_ID
The name of the local resource.

Output parameters

RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
INVALID_CLIENT_NAME,
INVALID_LOCAL_ACCESS_ID

RMSL gate, TAKE_ACTIVITY_KEYPOINT function

This function performs the activity associated with taking a keypoint.

Input parameters

None

Output parameters

RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION None

RMWT gate, INQUIRE_WORK_TOKEN function

This function returns the value of the work token belonging to the named Recovery Manager client in a particular unit of work object.

Input parameters

UOW_TOKEN
An optional parameter specifying the token identifying a unit of work object. If not specified the work token from the current unit of work of the currently executing transaction is returned.
CLIENT_NAME
The name of a Recovery Manager client.

Output parameters

WORK_TOKEN
The value of the Recovery Manager clients work token in the specified unit of work object.
RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION NOT_FOUND

RMWT gate, START_WORK_TOKEN_BROWSE function

This function starts a browse of a all the non-zero work tokens in the system for a specific Recovery Manager client.

Input parameters

CLIENT_NAME
The name of a Recovery Manager client.

Output parameters

BROWSE_TOKEN
A token to be used during the browse.
RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION NOT_FOUND

RMWT gate, GET_NEXT_WORK_TOKEN function

This function returns the next non-zero work token for the Recovery Manager client specified on the START_WORK_TOKEN_BROWSE. The token used to identify the unit of work object and local UOWID associated with the work token are also optionally returned.

Input parameters

BROWSE_TOKEN
A token identifying the browse.

Output parameters

WORK_TOKEN
The value of the Recovery Manager clients work token.
UOW_TOKEN
The token identifying the unit of work object.
LOCAL_UOW_ID
The local UOWID.
RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
INVALID_BROWSE_TOKEN,
BROWSE_END

RMWT gate, END_WORK_TOKEN_BROWSE function

This function terminates a browse of work tokens.

Input parameters

BROWSE_TOKEN
A token identifying the browse.

Output parameters

RESPONSE
is the Recovery Manager domain’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION INVALID_BROWSE_TOKEN
[[ Contents Previous Page | Next Page Index ]]