Class: TStandardTransaction

Declaration: CcrmStandardTransaction.h

Taxonomy Categories:

Member Functions:


Interface Category:

API.

Inherits From:

TTransaction

Inherited By:

None.

Purpose:

Constructs an initialized TStandardTransaction.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None. Overriding this class is not recommended, however if you wish do the following: Driving classes could override Commit, RollBack, Checkpoint and SavePoint, However, overriding Commit and RollBack will require Releasing all the Locks held by Transaction in order to preserve 2 Phase Locking semantic. Calling TStandardTransaction Commit or Rollback will release all the locks owned.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TStandardTransaction::TStandardTransaction

TStandardTransaction (ETransactionType transactionType =kRead)

Interface Category:

API.

Purpose:

Constructor for a TStandardTransaction object.

Calling Context:

Called to define and embrace the scope of transactional operations. Call this function directly.

Parameters:

Return Value:

None.

Exceptions:

Throws TInvalidTransaction and passes all other exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardTransaction::~TStandardTransaction

virtual ~ TStandardTransaction ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy a TStandardTransaction object.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardTransaction::CheckPoint

virtual void CheckPoint ()

Interface Category:

API.

Purpose:

Takes Checkpoint of the current active transaction, forces all log records and updates to the Recoverable entity.

Calling Context:

Called by application to take Checkpoint.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardTransaction::Commit

virtual void Commit ()

Interface Category:

API.

Purpose:

Commits the transaction in scope and releases all the locks held.

Calling Context:

Called to Commit an active transaction.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardTransaction::RollBack

virtual void RollBack ()

Interface Category:

API.

Purpose:

Rolls back all changes to Transactional/Recoverable objects registered with transaction and releases all locks held.

Calling Context:

Called by application to Rollback/Undo. Called by Recovery manager upon abnormal termination of transaction. Called by DeadLock Prevention/Detection.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardTransaction::GetActiveTransaction

static TStandardTransaction * GetActiveTransaction ()

Interface Category:

API.

Purpose:

Returns the current active transaction when one is in scope.

Calling Context:

Called to get the current transaction.

Parameters:

Return Value:

A TStandardTransaction pointer.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardTransaction::GetDummy

static TStandardTransaction * GetDummy ()

Interface Category:

API.

Purpose:

Instantiates an instance of a Dummy transaction.

Calling Context:

Called to instantiate a Dummy transaction.

Parameters:

Return Value:

A TStandardTransaction pointer.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardTransaction::SavePoint

virtual void SavePoint ()

Interface Category:

API.

Purpose:

Takes Checkpoint of the current active transaction, forces all log records and updates to the Recoverable entity and Releases all Locks held by transaction.

Calling Context:

Called by application to take Savepoint.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.
Click the icon to mail questions or corrections about this material to Taligent personnel.
Copyright©1995 Taligent,Inc. All rights reserved.