IEnlistmentNotification インターフェイス

定義

名前空間:

System.Transactions

アセンブリ:

System.Transactions.Local.dll

リソース マネージャーが参加の登録時にトランザクション マネージャーに対して 2 フェーズ コミット通知コールバックを提供するために実装する必要があるインターフェイスについて説明します。

public interface class IEnlistmentNotification

public interface IEnlistmentNotification

type IEnlistmentNotification = interface

Public Interface IEnlistmentNotification

派生

System.Transactions.ISinglePhaseNotification

例

次の例は、このインターフェイスの実装と、 メソッドを使用してオブジェクトをトランザクションの参加要素として参加させる方法を EnlistVolatile 示しています。

static void Main(string[] args)
{
    try
    {
        using (TransactionScope scope = new TransactionScope())
        {
        
            //Create an enlistment object
            myEnlistmentClass myElistment = new myEnlistmentClass();

            //Enlist on the current transaction with the enlistment object
            Transaction.Current.EnlistVolatile(myElistment, EnlistmentOptions.None);

            //Perform transactional work here.

            //Call complete on the TransactionScope based on console input
                            ConsoleKeyInfo c;
            while(true)
                            {
                Console.Write("Complete the transaction scope? [Y|N] ");
                c = Console.ReadKey();
                Console.WriteLine();
        
                                    if ((c.KeyChar == 'Y') || (c.KeyChar == 'y'))
                {
                    scope.Complete();
                    break;
                }
                else if ((c.KeyChar == 'N') || (c.KeyChar == 'n'))
                {
                    break;
                }
            }
        }
    }
    catch (System.Transactions.TransactionException ex)
    {
        Console.WriteLine(ex);
    }
    catch
    {
        Console.WriteLine("Cannot complete transaction");
        throw;
    }
}

class myEnlistmentClass : IEnlistmentNotification
{
    public void Prepare(PreparingEnlistment preparingEnlistment)
    {
        Console.WriteLine("Prepare notification received");

        //Perform transactional work

        //If work finished correctly, reply prepared
        preparingEnlistment.Prepared();

        // otherwise, do a ForceRollback
        preparingEnlistment.ForceRollback();
    }

    public void Commit(Enlistment enlistment)
    {
        Console.WriteLine("Commit notification received");

        //Do any work necessary when commit notification is received

        //Declare done on the enlistment
        enlistment.Done();
    }

    public void Rollback(Enlistment enlistment)
    {
        Console.WriteLine("Rollback notification received");

        //Do any work necessary when rollback notification is received

        //Declare done on the enlistment
        enlistment.Done();
    }

    public void InDoubt(Enlistment enlistment)
    {
        Console.WriteLine("In doubt notification received");

        //Do any work necessary when indout notification is received
        
        //Declare done on the enlistment
        enlistment.Done();
    }
}

    Public Shared Sub Main()
        Try
            Using scope As TransactionScope = New TransactionScope()

                'Create an enlistment object
                Dim myEnlistmentClass As New EnlistmentClass

                'Enlist on the current transaction with the enlistment object
                Transaction.Current.EnlistVolatile(myEnlistmentClass, EnlistmentOptions.None)

                'Perform transactional work here.

                'Call complete on the TransactionScope based on console input
                Dim c As ConsoleKeyInfo
                While (True)
                    Console.Write("Complete the transaction scope? [Y|N] ")
                    c = Console.ReadKey()
                    Console.WriteLine()
                    If (c.KeyChar = "Y") Or (c.KeyChar = "y") Then
                        scope.Complete()
                        Exit While
                    ElseIf ((c.KeyChar = "N") Or (c.KeyChar = "n")) Then
                        Exit While
                    End If
                End While
            End Using
        Catch ex As TransactionException
            Console.WriteLine(ex)
        Catch
            Console.WriteLine("Cannot complete transaction")
            Throw
        End Try
    End Sub
End Class

Public Class EnlistmentClass
    Implements IEnlistmentNotification

    Public Sub Prepare(ByVal myPreparingEnlistment As PreparingEnlistment) Implements System.Transactions.IEnlistmentNotification.Prepare
        Console.WriteLine("Prepare notification received")

        'Perform transactional work

        'If work finished correctly, reply with prepared
        myPreparingEnlistment.Prepared()
    End Sub

    Public Sub Commit(ByVal myEnlistment As Enlistment) Implements System.Transactions.IEnlistmentNotification.Commit
        Console.WriteLine("Commit notification received")

        'Do any work necessary when commit notification is received

        'Declare done on the enlistment
        myEnlistment.Done()
    End Sub

    Public Sub Rollback(ByVal myEnlistment As Enlistment) Implements System.Transactions.IEnlistmentNotification.Rollback
        Console.WriteLine("Rollback notification received")

        'Do any work necessary when rollback notification is received

        'Declare done on the enlistment
        myEnlistment.Done()
    End Sub

    Public Sub InDoubt(ByVal myEnlistment As Enlistment) Implements System.Transactions.IEnlistmentNotification.InDoubt
        Console.WriteLine("In doubt notification received")

        'Do any work necessary when indout notification is received

        'Declare done on the enlistment
        myEnlistment.Done()
    End Sub
End Class

注釈

リソース マネージャーがトランザクションに参加するには、トランザクション マネージャーを介してトランザクションに参加する必要があります。 Transaction クラスは、この機能を提供する一連のメソッドを定義しています。これらのメソッドの名前は Enlist で始まります。 さまざまな Enlist メソッドは、リソース マネージャーが持つ各種の参加リストにそれぞれ対応しています。

このクラスは、参加の参加時にトランザクション マネージャーに対して 2 つのフェーズ コミット通知コールバックを提供するために、リソース マネージャーが実装する必要があるインターフェイスについて説明します。 リソース マネージャーのインターフェイスのIEnlistmentNotification実装ごとに、リソースが揮発性か持続性かに応じて、 クラスの Transaction メソッドまたは EnlistDurable メソッドを使用してEnlistVolatile参加させる必要があります。 参加と 2PC の詳細については、「 リソースをトランザクションの参加者として参加させる 」および「 Single-Phaseおよびマルチフェーズでのトランザクションのコミット 」を参照してください。

トランザクション マネージャーは、次の方法で、2 フェーズ コミット プロトコルの異なるフェーズで参加オブジェクトに通知します。

メソッド	説明
Prepare	参加オブジェクトのこのメソッドは、トランザクションマネージャーがトランザクションをコミットできるかどうかを参加者に尋ねると、トランザクションマネージャーがトランザクションの最初のフェーズでコールバックとして使用されます。
Commit	参加オブジェクトのこのメソッドは、トランザクションがコミットされている場合、トランザクションの第 2 フェーズ中にトランザクション マネージャーによってコールバックとして使用されます。
Rollback	参加オブジェクトのこのメソッドは、トランザクションが中止 (つまりロールバック) された場合、トランザクション の 2 番目のフェーズ中にトランザクション マネージャーによってコールバックとして使用されます。
InDoubt	参加オブジェクトのこのメソッドは、トランザクションが不明な場合、トランザクションの第 2 フェーズ中にトランザクション マネージャーによってコールバックとして使用されます。

Note

通知が順番に送信されたり、特定の順序で送信されたりしないことがあることに注意する必要があります。

メソッド

Commit(Enlistment)	トランザクションのコミット中であることを参加オブジェクトに通知します。
InDoubt(Enlistment)	トランザクションのステータスが未決定であることを参加オブジェクトに通知します。
Prepare(PreparingEnlistment)	トランザクションのコミットの準備中であることを参加オブジェクトに通知します。
Rollback(Enlistment)	トランザクションのロールバック (中止) 中であることを参加オブジェクトに通知します。

こちらもご覧ください

• ISinglePhaseNotification
• トランザクションの参加要素としてのリソースの参加
• 単一フェースおよび複数フェーズでのトランザクションのコミット