ISinglePhaseNotification Interface

Definition

Describes a resource object that supports single phase commit optimization to participate in a transaction.

public interface class ISinglePhaseNotification : System::Transactions::IEnlistmentNotification
public interface ISinglePhaseNotification : System.Transactions.IEnlistmentNotification
type ISinglePhaseNotification = interface
    interface IEnlistmentNotification
Public Interface ISinglePhaseNotification
Implements IEnlistmentNotification
Implements

Remarks

You should note that even when your resource manager implements this interface to support single phase commit optimization, it is not guaranteed that it receives a single phase commit. The transaction manager can still send two phase commit notifications instead.

To enlist your resource manager as a participant in a transaction, call the EnlistVolatile method or the EnlistDurable method of the Transaction class. Specifically, the EnlistmentOptions parameter should equal to None to ensure that a single phase commit is performed. If it is mistakenly set to EnlistDuringPrepareRequired, no single phase commit occurs.

Since the ISinglePhaseNotification interface derives from the IEnlistmentNotification interface, the resource manager must also implement all the methods of the latter for two phase commit notifications. It is the transaction manager's choice as to whether two phase commit or the single phase commit optimization is used with this resource manager. However, implementing this interface gives the resource manager the opportunity to take advantage of the optimization when it is available.

If the optimization is used and the transaction manager calls the SinglePhaseCommit method of the enlisted resource, the resource manager should respond to this call by using various methods of the SinglePhaseEnlistment class to inform the transaction manager if the transaction is to be committed or rolled back.

Methods

Commit(Enlistment)

Notifies an enlisted object that a transaction is being committed.

(Inherited from IEnlistmentNotification)
InDoubt(Enlistment)

Notifies an enlisted object that the status of a transaction is in doubt.

(Inherited from IEnlistmentNotification)
Prepare(PreparingEnlistment)

Notifies an enlisted object that a transaction is being prepared for commitment.

(Inherited from IEnlistmentNotification)
Rollback(Enlistment)

Notifies an enlisted object that a transaction is being rolled back (aborted).

(Inherited from IEnlistmentNotification)
SinglePhaseCommit(SinglePhaseEnlistment)

Represents the resource manager's implementation of the callback for the single phase commit optimization.

Applies to

See also