Export (0) Print
Expand All

CommittableTransaction Class

Describes a committable transaction.

System.Object
  System.Transactions.Transaction
    System.Transactions.CommittableTransaction

Namespace:  System.Transactions
Assembly:  System.Transactions (in System.Transactions.dll)

[SerializableAttribute]
public sealed class CommittableTransaction : Transaction, 
	IAsyncResult

The CommittableTransaction type exposes the following members.

  NameDescription
Public methodCommittableTransaction()Initializes a new instance of the CommittableTransaction class.
Public methodCommittableTransaction(TimeSpan)Initializes a new instance of the CommittableTransaction class with the specified timeout value.
Public methodCommittableTransaction(TransactionOptions)Initializes a new instance of the CommittableTransaction class with the specified transaction options.
Top

  NameDescription
Public propertyIsolationLevelGets the isolation level of the transaction. (Inherited from Transaction.)
Public propertyTransactionInformationRetrieves additional information about a transaction. (Inherited from Transaction.)
Top

  NameDescription
Public methodBeginCommitBegins an attempt to commit the transaction asynchronously.
Public methodCloneCreates a clone of the transaction. (Inherited from Transaction.)
Public methodCommitAttempts to commit the transaction.
Public methodDependentCloneCreates a dependent clone of the transaction. (Inherited from Transaction.)
Public methodDisposeReleases the resources that are held by the object. (Inherited from Transaction.)
Public methodEndCommitEnds an attempt to commit the transaction asynchronously.
Public methodEnlistDurable(Guid, IEnlistmentNotification, EnlistmentOptions)Enlists a durable resource manager that supports two phase commit to participate in a transaction. (Inherited from Transaction.)
Public methodEnlistDurable(Guid, ISinglePhaseNotification, EnlistmentOptions)Enlists a durable resource manager that supports single phase commit optimization to participate in a transaction. (Inherited from Transaction.)
Public methodEnlistPromotableSinglePhaseEnlists a resource manager that has an internal transaction using a promotable single phase enlistment (PSPE). (Inherited from Transaction.)
Public methodEnlistVolatile(IEnlistmentNotification, EnlistmentOptions)Enlists a volatile resource manager that supports two phase commit to participate in a transaction. (Inherited from Transaction.)
Public methodEnlistVolatile(ISinglePhaseNotification, EnlistmentOptions)Enlists a volatile resource manager that supports single phase commit optimization to participate in a transaction. (Inherited from Transaction.)
Public methodEqualsDetermines whether this transaction and the specified object are equal. (Inherited from Transaction.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from Transaction.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodRollback()Rolls back (aborts) the transaction. (Inherited from Transaction.)
Public methodRollback(Exception)Rolls back (aborts) the transaction. (Inherited from Transaction.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public eventTransactionCompletedIndicates that the transaction is completed. (Inherited from Transaction.)
Top

  NameDescription
Explicit interface implemetationPrivate propertyIAsyncResult.AsyncStateGets the object provided as the last parameter of the BeginCommit method call.
Explicit interface implemetationPrivate propertyIAsyncResult.AsyncWaitHandleGets a WaitHandle that is used to wait for an asynchronous operation to complete.
Explicit interface implemetationPrivate propertyIAsyncResult.CompletedSynchronouslyGets an indication of whether the asynchronous commit operation completed synchronously.
Explicit interface implemetationPrivate propertyIAsyncResult.IsCompletedGets an indication whether the asynchronous commit operation has completed.
Explicit interface implemetationPrivate methodISerializable.GetObjectDataGets a SerializationInfo with the data required to serialize this transaction. (Inherited from Transaction.)
Top

The CommittableTransaction class provides an explicit way for applications to use a transaction, as opposed to using the TransactionScope class implicitly. Unlike the TransactionScope class, the application writer needs to specifically call the Commit and Rollback methods in order to commit or abort the transaction. However, only the creator of a transaction can commit the transaction. Therefore, copies of a committable transaction, obtained through the Clone method are not committable.

NoteNote

It is recommended that you create implicit transactions using the TransactionScope class, so that the ambient transaction context is automatically managed for you. You should also use the TransactionScope and DependentTransaction class for applications that require the use of the same transaction across multiple function calls or multiple thread calls. For more information on this model, see the Implementing An Implicit Transaction Using Transaction Scope topic.

Creating a CommittableTransaction does not automatically set the ambient transaction, which is the transaction your code executes in. You can get or set the ambient transaction by calling the static Current property of the global Transaction object. For more information on ambient transactions, see the " Managing Transaction Flow using TransactionScopeOption" section of the Implementing An Implicit Transaction Using Transaction Scope topic. If the ambient transaction is not set, any operation on a resource manager is not part of that transaction. You need to explicitly set and reset the ambient transaction, to ensure that resource managers operate under the right transaction context.

Until a CommittableTransaction has been committed, all the resources involved with the transaction are still locked.

A CommittableTransaction object cannot be reused. Once it has been committed or rolled back, it cannot be used again in a transaction or set as the current ambient transaction context.

The following sample creates two new instances of CommittableTransaction, commits and rolls back them respectively.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

This type is thread safe.

Community Additions

ADD
Show:
© 2014 Microsoft