Kernel Transaction Manager Functions

The following functions are used with transactions.

FunctionDescription
CommitTransactionRequests that the specified transaction be committed.
CommitTransactionAsyncRequests that the specified transaction be committed.
CreateTransactionCreates a new transaction object.
GetTransactionIdObtains the ID for the specified transaction.
GetTransactionInformationReturns the requested information about the specified transaction.
OpenTransactionOpens an existing transaction.
RollbackCompleteIndicates that the resource manager (RM) has successfully completed rolling back a transaction.
RollbackTransactionRequests that the specified transaction be rolled back.
RollbackTransactionAsyncRequests that the specified transaction be rolled back. This function returns asynchronously.
SetTransactionInformationSets the transaction information for the specified transaction.

 

The following functions are used with enlistments.

FunctionDescription
CommitCompleteIndicates that a RM has finished committing a transaction that was requested by the transaction manager (TM).
CommitEnlistmentCommits the transaction for the specified enlistment.
GetEnlistmentIdObtains the ID for the specified enlistment.
CreateEnlistmentCreates an enlistment, sets its initial state, and opens a handle to the enlistment with the specified access.
GetEnlistmentRecoveryInformationRetrieves an opaque structure of recovery data from KTM. Recovery information is stored in a log on behalf of a RM by calling the SetEnlistmentRecoveryInformation function. After a failure, the RM can use the GetEnlistmentRecoveryInformation function to retrieve the information.
OpenEnlistmentOpens an existing enlistment object, and returns a handle to the enlistment.
PrepareEnlistmentCalled by superior TM to indicate that their pre-prepares work has been completed.
PrePrepareEnlistmentCalled by superior TM to indicate that their pre-prepares work has been completed.
RecoverEnlistmentRecovers an enlistment's state.
ReadOnlyEnlistmentRequests that the specified enlistment be converted to a read-only enlistment. A read-only enlistment cannot participate in the outcome of the transaction and is not durably recorded for recovery.
RollbackEnlistmentRolls back the specified transaction that is associated with an enlistment. This function cannot be called for read-only enlistments.
SetEnlistmentRecoveryInformationSets an opaque, user-defined structure of recovery data from KTM. Recovery information is stored in a log on behalf of a RM by calling SetEnlistmentRecoveryInformation. After a failure, the RM can use GetEnlistmentRecoveryInformation to retrieve the information.
SinglePhaseRejectIndicates that the RM is refusing a single-phase request. When a TM receives this call, it initiates a two-phase commit and sends a prepare request to all enlisted RMs.

 

The following functions are used with resource managers.

FunctionDescription
CreateResourceManagerCreates a new RM object, and associates the RM with a transaction manager (TM).
GetNotificationResourceManagerRequests and receives a notification for RM. This function is used by the RM register to receive notifications when a transaction changes state.
GetNotificationResourceManagerAsyncRequests and receives asynchronous notification for a RM. This function is used by the RM to register to receive notifications when a transaction changes state.
OpenResourceManagerOpens an existing RM.
PrepareCompleteIndicates that the RM has completed all processing necessary to guarantee that a commit or abort operation will succeed for the specified transaction.
PrePrepareCompleteSignals that this RM has completed its preprepare work, so that other RMs can now begin their prepare operations.
RecoverResourceManagerRecovers a RM's state from its log file.
SetResourceManagerCompletionPortAssociates the specified I/O completion port with the specified RM. This port receives all notifications for the RM.

 

The following functions are used with transaction managers.

FunctionDescription
CreateTransactionManagerCreates a new TM object and returns a handle with the specified access.
GetCurrentClockTransactionManagerObtains a virtual clock value from a TM.
GetTransactionManagerIdObtains an identifier for the specified TM.
OpenTransactionManagerOpens an existing TM.
OpenTransactionManagerByIdOpens an existing TM.
RecoverTransactionManagerRecovers a TM's state from its log file.
RenameTransactionManagerRenames a TM.
RollforwardTransactionManagerRecovers TM's state from its log file to the specified virtual clock value.

 

Send comments about this topic to Microsoft

Build date: 9/3/2009

Tags :


Page view tracker