CommittableTransaction Class

Reference

Definition

Namespace:: System.Transactions

Assembly:: System.Transactions.Local.dll

Assembly:: System.Transactions.dll

Assembly:: netstandard.dll

Source:: CommittableTransaction.cs

Source:: CommittableTransaction.cs

Source:: CommittableTransaction.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Describes a committable transaction.

public ref class CommittableTransaction sealed : System::Transactions::Transaction, IAsyncResult

public sealed class CommittableTransaction : System.Transactions.Transaction, IAsyncResult

[System.Runtime.Versioning.UnsupportedOSPlatform("browser")]
public sealed class CommittableTransaction : System.Transactions.Transaction, IAsyncResult

[System.Serializable]
public sealed class CommittableTransaction : System.Transactions.Transaction, IAsyncResult

type CommittableTransaction = class
    inherit Transaction
    interface IAsyncResult

[<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
type CommittableTransaction = class
    inherit Transaction
    interface IAsyncResult

[<System.Serializable>]
type CommittableTransaction = class
    inherit Transaction
    interface IAsyncResult

Public NotInheritable Class CommittableTransaction
Inherits Transaction
Implements IAsyncResult

Inheritance: Object

Transaction
CommittableTransaction

Attributes: UnsupportedOSPlatformAttribute SerializableAttribute

Implements: IAsyncResult

Remarks

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 Transaction.Clone method are not committable.

Note

We recommend 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 classes 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 Transaction.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.

Constructors

CommittableTransaction()	Initializes a new instance of the CommittableTransaction class.
CommittableTransaction(TimeSpan)	Initializes a new instance of the CommittableTransaction class with the specified `timeout` value.
CommittableTransaction(TransactionOptions)	Initializes a new instance of the CommittableTransaction class with the specified transaction options.

Properties

IsolationLevel	Gets the isolation level of the transaction. (Inherited from Transaction)
PromoterType	Uniquely identifies the format of the `byte[]` returned by the Promote method when the transaction is promoted. (Inherited from Transaction)
TransactionInformation	Retrieves additional information about a transaction. (Inherited from Transaction)

Methods

BeginCommit(AsyncCallback, Object)	Begins an attempt to commit the transaction asynchronously.
Clone()	Creates a clone of the transaction. (Inherited from Transaction)
Commit()	Attempts to commit the transaction.
DependentClone(DependentCloneOption)	Creates a dependent clone of the transaction. (Inherited from Transaction)
Dispose()	Releases the resources that are held by the object. (Inherited from Transaction)
EndCommit(IAsyncResult)	Ends an attempt to commit the transaction asynchronously.
EnlistDurable(Guid, IEnlistmentNotification, EnlistmentOptions)	Enlists a durable resource manager that supports two phase commit to participate in a transaction. (Inherited from Transaction)
EnlistDurable(Guid, ISinglePhaseNotification, EnlistmentOptions)	Enlists a durable resource manager that supports single phase commit optimization to participate in a transaction. (Inherited from Transaction)
EnlistPromotableSinglePhase(IPromotableSinglePhaseNotification, Guid)	Enlists a resource manager that has an internal transaction using a promotable single phase enlistment (PSPE). (Inherited from Transaction)
EnlistPromotableSinglePhase(IPromotableSinglePhaseNotification)	Enlists a resource manager that has an internal transaction using a promotable single phase enlistment (PSPE). (Inherited from Transaction)
EnlistVolatile(IEnlistmentNotification, EnlistmentOptions)	Enlists a volatile resource manager that supports two phase commit to participate in a transaction. (Inherited from Transaction)
EnlistVolatile(ISinglePhaseNotification, EnlistmentOptions)	Enlists a volatile resource manager that supports single phase commit optimization to participate in a transaction. (Inherited from Transaction)
Equals(Object)	Determines whether this transaction and the specified object are equal. (Inherited from Transaction)
GetHashCode()	Returns the hash code for this instance. (Inherited from Transaction)
GetPromotedToken()	Gets the `byte[]` returned by the `Promote` method when the transaction is promoted. (Inherited from Transaction)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
PromoteAndEnlistDurable(Guid, IPromotableSinglePhaseNotification, ISinglePhaseNotification, EnlistmentOptions)	Promotes and enlists a durable resource manager that supports two phase commit to participate in a transaction. (Inherited from Transaction)
Rollback()	Rolls back (aborts) the transaction. (Inherited from Transaction)
Rollback(Exception)	Rolls back (aborts) the transaction. (Inherited from Transaction)
SetDistributedTransactionIdentifier(IPromotableSinglePhaseNotification, Guid)	Sets the distributed transaction identifier generated by the non-MSDTC promoter. (Inherited from Transaction)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Events

TransactionCompleted

Indicates that the transaction is completed.

(Inherited from Transaction)

Explicit Interface Implementations

IAsyncResult.AsyncState	Gets the object provided as the last parameter of the BeginCommit(AsyncCallback, Object) method call.
IAsyncResult.AsyncWaitHandle	Gets a WaitHandle that is used to wait for an asynchronous operation to complete.
IAsyncResult.CompletedSynchronously	Gets an indication of whether the asynchronous commit operation completed synchronously.
IAsyncResult.IsCompleted	Gets an indication whether the asynchronous commit operation has completed.
ISerializable.GetObjectData(SerializationInfo, StreamingContext)	Gets a SerializationInfo with the data required to serialize this transaction. (Inherited from Transaction)

Applies to

Thread Safety

This type is thread safe.

Share via