CommittableTransaction Class

CommittableTransaction Class

 

Describes a committable transaction.

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

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

[SerializableAttribute]
public sealed class CommittableTransaction : Transaction, IAsyncResult

NameDescription
System_CAPS_pubmethodCommittableTransaction()

Initializes a new instance of the CommittableTransaction class.

System_CAPS_pubmethodCommittableTransaction(TimeSpan)

Initializes a new instance of the CommittableTransaction class with the specified timeout value.

System_CAPS_pubmethodCommittableTransaction(TransactionOptions)

Initializes a new instance of the CommittableTransaction class with the specified transaction options.

NameDescription
System_CAPS_pubpropertyIsolationLevel

Gets the isolation level of the transaction.(Inherited from Transaction.)

System_CAPS_pubpropertyPromoterType

Uniquely identifies the format of the byte[] returned by the Promote method when the transaction is promoted.(Inherited from Transaction.)

System_CAPS_pubpropertyTransactionInformation

Retrieves additional information about a transaction.(Inherited from Transaction.)

NameDescription
System_CAPS_pubmethodBeginCommit(AsyncCallback, Object)

Begins an attempt to commit the transaction asynchronously.

System_CAPS_pubmethodClone()

Creates a clone of the transaction.(Inherited from Transaction.)

System_CAPS_pubmethodCommit()

Attempts to commit the transaction.

System_CAPS_pubmethodDependentClone(DependentCloneOption)

Creates a dependent clone of the transaction.(Inherited from Transaction.)

System_CAPS_pubmethodDispose()

Releases the resources that are held by the object.(Inherited from Transaction.)

System_CAPS_pubmethodEndCommit(IAsyncResult)

Ends an attempt to commit the transaction asynchronously.

System_CAPS_pubmethodEnlistDurable(Guid, IEnlistmentNotification, EnlistmentOptions)

Enlists a durable resource manager that supports two phase commit to participate in a transaction.(Inherited from Transaction.)

System_CAPS_pubmethodEnlistDurable(Guid, ISinglePhaseNotification, EnlistmentOptions)

Enlists a durable resource manager that supports single phase commit optimization to participate in a transaction.(Inherited from Transaction.)

System_CAPS_pubmethodEnlistPromotableSinglePhase(IPromotableSinglePhaseNotification)

Enlists a resource manager that has an internal transaction using a promotable single phase enlistment (PSPE). (Inherited from Transaction.)

System_CAPS_pubmethodEnlistPromotableSinglePhase(IPromotableSinglePhaseNotification, Guid)

Enlists a resource manager that has an internal transaction using a promotable single phase enlistment (PSPE).(Inherited from Transaction.)

System_CAPS_pubmethodEnlistVolatile(IEnlistmentNotification, EnlistmentOptions)

Enlists a volatile resource manager that supports two phase commit to participate in a transaction.(Inherited from Transaction.)

System_CAPS_pubmethodEnlistVolatile(ISinglePhaseNotification, EnlistmentOptions)

Enlists a volatile resource manager that supports single phase commit optimization to participate in a transaction.(Inherited from Transaction.)

System_CAPS_pubmethodEquals(Object)

Determines whether this transaction and the specified object are equal.(Inherited from Transaction.)

System_CAPS_pubmethodGetHashCode()

Returns the hash code for this instance.(Inherited from Transaction.)

System_CAPS_pubmethodGetPromotedToken()

Gets the byte[] returned by the Promote method when the transaction is promoted.(Inherited from Transaction.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodPromoteAndEnlistDurable(Guid, IPromotableSinglePhaseNotification, ISinglePhaseNotification, EnlistmentOptions)

[Supported in the .NET Framework 4.5.2 and later versions]

Promotes and enlists a durable resource manager that supports two phase commit to participate in a transaction.(Inherited from Transaction.)

System_CAPS_pubmethodRollback()

Rolls back (aborts) the transaction.(Inherited from Transaction.)

System_CAPS_pubmethodRollback(Exception)

Rolls back (aborts) the transaction.(Inherited from Transaction.)

System_CAPS_pubmethodSetDistributedTransactionIdentifier(IPromotableSinglePhaseNotification, Guid)

Sets the distributed transaction identifier generated by the non-MSDTC promoter.(Inherited from Transaction.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubeventTransactionCompleted

Indicates that the transaction is completed.(Inherited from Transaction.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodISerializable.GetObjectData(SerializationInfo, StreamingContext)

Gets a SerializationInfo with the data required to serialize this transaction. (Inherited from Transaction.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIAsyncResult.AsyncState

Gets the object provided as the last parameter of the BeginCommit method call.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIAsyncResult.AsyncWaitHandle

Gets a WaitHandle that is used to wait for an asynchronous operation to complete.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIAsyncResult.CompletedSynchronously

Gets an indication of whether the asynchronous commit operation completed synchronously.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIAsyncResult.IsCompleted

Gets an indication whether the asynchronous commit operation has completed.

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.

System_CAPS_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
Available since 2.0

This type is thread safe.

System.Transactions Namespace
Implementing An Implicit Transaction Using Transaction Scope
Implementing An Explicit Transaction Using CommittableTransaction

Return to top
Show:
© 2016 Microsoft