Object Transaction Service domain’s specific gates

Table 76 summarizes the OT 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).

Table 76. Object Transaction Service domain’s specific gates
Gate Trace Function XPI
OTTR
OT 0401
OT 0402
IMPORT_TRAN
BEGIN_TRAN
COMMIT_ONE_PHASE
PREPARE
COMMIT
ROLLBACK
SET_ROLLBACK_ONLY
NO
NO
NO
NO
NO
NO
NO
OTSU
XM 0501
XM 0502
ADD_SUBORDINATE
SET_VOTE
FORGET
RESYNC
NO
NO
NO
OTCO
XM 0601
XM 0602
SET_COORDINATOR
FORGET
RESYNC
NO
NO
NO
OTRM
XM 0701
XM 0702
PERFORM_PRELOGGING
PERFORM_PREPARE
PERFORM_COMMIT
REPLY_DO_COMMIT
SEND_DO_COMMIT
PERFORM_SHUNT
PERFORM_UNSHUNT
START_BACKOUT
DELIVER_BACKOUT_DATA
END_BACKOUT
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO

OTTR gate, IMPORT_TRAN function

The IMPORT_TRAN function of the OTTR gate is used to import an OTS transaction to a task.

Input parameters

FORMAT_ID
The OTS transactions format identifier.
BQUAL_LEN
The batch qualifer length of the OTS transaction.
TID_BLOCK_IN
The OTS transaction identifier (TID) of the transaction being imported.
TIMEOUT
The OTS transaction timeout value.
LOGICAL_SERVER
The name of the logical server within which the transaction is executing.
PUBLIC_ID
The Request Stream public identifier associated with the transaction.

Output parameters

UOW_ID
The identifier of the logical unit of work into which the OTS transaction was imported.
RESPONSE
is the domain’s response to the call. It can have any 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 TID_TOO_LONG
INVALID INVALID_FUNCTION

OTTR gate, BEGIN_TRAN function

The BEGIN_TRAN function of the OTTR gate is used to create a new OTS transaction.

Input parameters

[TIMEOUT]
The timeout specified for the new OTS transaction.
TID_BUFFER_OUT
The OTS transaction identifier (TID) of the transaction created.
LOGICAL_SERVER
The name of the logical server within which the transaction is executing.
PUBLIC_ID
The Request Stream public identifier associated with the transaction.

Output parameters

FORMAT_ID
The OTS transactions format identifier.
BQUAL_LEN
The batch qualifer length of the OTS transaction.
[TIMEOUT]
The default OTS transaction timeout value.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
TID_TOO_LONG
UOW_ROLLEDBACK

OTTR gate, COMMIT_ONE_PHASE function

The COMMIT_ONE_PHASE function of the OTTR gate is used to attempt to commit the current OTS transaction.

Input parameters

None

Output parameters

STATUS
The outcome of the OTS transaction. It can have either of these values:
COMMITTED|ROLLEDBACK
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
None

OTTR gate, PREPARE function

The PREPARE function of the OTTR gate is used to perform the first phase of the syncpoint of an OTS transaction.

Input parameters

None

Output parameters

VOTE
The vote from first phase of syncpoint. It can have any of these values:
YES|NO|READ_ONLY|HEURISTIC_MIXED
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
None

OTTR gate, COMMIT function

The COMMIT function of the OTTR gate is used to perform the second phase of the syncpoint of an OTS transaction.

Input parameters

None.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any 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_ROLLEDBACK

OTTR gate, SET_ROLLBACK_ONLY function

The SET_ROLLBACK_ONLY function of the OTTR gate is used to ensure that the OTS transaction will rollback when it comes to syncpoint.

Input parameters

None.

Output parameters

RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
None

OTSU gate, ADD_SUBORDINATE function

The ADD_SUBORDINATE function of the OTSU gate is used add a subordinate participant to the OTS transaction.

Input parameters

IOR_BLOCK
Block containing the CORBA IOR of the OTS Resource that is being added as a subordinate participant in the OTS transaction.
HOST_BLOCK
Block containing the name of the TCPIP host where the subordinate OTS resource resides.

Output parameters

SUBORDINATE_TOKEN
token representing the added Resource.
RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION or DISASTER. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
IOR_TOO_LONG
HOST_TOO_LONG
DISASTER ADD_LINK_FAILED

OTSU gate, SET_VOTE function

The SET_VOTE function of the OTSU gate is used record the vote that results from a PREPARE method being invoked on the OTS Resource represented by the given SUBORDINATE_TOKEN.

Input parameters

SUBORDINATE_TOKEN
Token representing the subordinate OTS resource.
VOTE
The vote resulting from the first phase of syncpoint on the subordinate resource. It can have one of the following values:
YES|NO|READ_ONLY|HEURISTIC_MIXED|
HEURISTIC_COMMIT|HEURISTIC_ROLLBACK|HEURISTIC_HAZARD

Output parameters

RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION or DISASTER. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
UNKNOWN_SUBORDINATE
INVALID_VOTE
DISASTER RECORD_VOTE_FAILED

OTSU gate, FORGET function

The FORGET function of the OTSU gate is used signal the fact that the obligation to the subordinate resource has been discharged.

Input parameters

SUBORDINATE_TOKEN
Token representing the subordinate OTS resource.

Output parameters

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

OTSU gate, RESYNC function

The RESYNC function of the OTSU gate is used to initiate the resynchronisation protocol with the subordinate resource identified by the given IOR.

Input parameters

IOR_BLOCK
Block containing the CORBA IOR of the OTS Resource with which to resynchronise.
UOWID
identification of the local logical unit of work managing the OTS transaction.

Output parameters

RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
None

OTCO gate, SET_COORDINATOR function

The SET_COORDINATOR function of the OTCO gate is used to make known the CORBA object that will coordinate this part of the OTS transaction.

Input parameters

IOR_BLOCK
Block containing the CORBA IOR of the OTS Coordinator.
HOST_BLOCK
Block containing the name of the TCPIP host where the coordinator resides.

Output parameters

COORDINATOR_TOKEN
token representing the coordinator.
RESPONSE
is the domain*s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
IOR_TOO_LONG
HOST_TO_LONG

OTCO gate, FORGET function

The FORGET function of the OTCO gate is used signal the fact that the obligation to the coordinator has been discharged.

Input parameters

SUBORDINATE_TOKEN
Token representing the subordinate OTS resource.

Output parameters

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