This topic has not yet been rated - Rate this topic

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.

  Name Description
Public method CommittableTransaction() Initializes a new instance of the CommittableTransaction class.
Public method CommittableTransaction(TimeSpan) Initializes a new instance of the CommittableTransaction class with the specified timeout value.
Public method CommittableTransaction(TransactionOptions) Initializes a new instance of the CommittableTransaction class with the specified transaction options.
Top
  Name Description
Public property IsolationLevel Gets the isolation level of the transaction. (Inherited from Transaction.)
Public property TransactionInformation Retrieves additional information about a transaction. (Inherited from Transaction.)
Top
  Name Description
Public method BeginCommit Begins an attempt to commit the transaction asynchronously.
Public method Clone Creates a clone of the transaction. (Inherited from Transaction.)
Public method Commit Attempts to commit the transaction.
Public method DependentClone Creates a dependent clone of the transaction. (Inherited from Transaction.)
Public method Dispose Releases the resources that are held by the object. (Inherited from Transaction.)
Public method EndCommit Ends an attempt to commit the transaction asynchronously.
Public method EnlistDurable(Guid, IEnlistmentNotification, EnlistmentOptions) Enlists a durable resource manager that supports two phase commit to participate in a transaction. (Inherited from Transaction.)
Public method EnlistDurable(Guid, ISinglePhaseNotification, EnlistmentOptions) Enlists a durable resource manager that supports single phase commit optimization to participate in a transaction. (Inherited from Transaction.)
Public method EnlistPromotableSinglePhase Enlists a resource manager that has an internal transaction using a promotable single phase enlistment (PSPE). (Inherited from Transaction.)
Public method EnlistVolatile(IEnlistmentNotification, EnlistmentOptions) Enlists a volatile resource manager that supports two phase commit to participate in a transaction. (Inherited from Transaction.)
Public method EnlistVolatile(ISinglePhaseNotification, EnlistmentOptions) Enlists a volatile resource manager that supports single phase commit optimization to participate in a transaction. (Inherited from Transaction.)
Public method Equals Determines whether this transaction and the specified object are equal. (Inherited from Transaction.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Returns the hash code for this instance. (Inherited from Transaction.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Rollback() Rolls back (aborts) the transaction. (Inherited from Transaction.)
Public method Rollback(Exception) Rolls back (aborts) the transaction. (Inherited from Transaction.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Public event TransactionCompleted Indicates that the transaction is completed. (Inherited from Transaction.)
Top
  Name Description
Explicit interface implemetation Private property IAsyncResult.AsyncState Gets the object provided as the last parameter of the BeginCommit method call.
Explicit interface implemetation Private property IAsyncResult.AsyncWaitHandle Gets a WaitHandle that is used to wait for an asynchronous operation to complete.
Explicit interface implemetation Private property IAsyncResult.CompletedSynchronously Gets an indication of whether the asynchronous commit operation completed synchronously.
Explicit interface implemetation Private property IAsyncResult.IsCompleted Gets an indication whether the asynchronous commit operation has completed.
Explicit interface implemetation Private method ISerializable.GetObjectData Gets 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.

Note Note

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.

Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ
Missing example code
The Examples section does not have any code in it