Class: TTransaction

Declaration: CcrmStandardTransaction.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

TStandardTransaction

Purpose:

A base type for objects representing transaction.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

TStandardTransaction. If you wish to design your own transaction, you can drive from this class. Derived classed must override Commit and RollBack, you also are responsible for setting Transaction ID. Derived classes must preserve 2 Phase Locking semantic as well.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TTransaction::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:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTransaction::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:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTransaction::GetTransType

ETransactionType GetTransType () const

Interface Category:

API.

Purpose:

Returns the transaction type.

Calling Context:

Called to get the transaction type.

Parameters:

Takes no parameters.

Return Value:

ETransactionType.

Exceptions:

Throws no exceptions.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTransaction::GetStatus

EStatus GetStatus () const

Interface Category:

API.

Purpose:

Returns the status of the transaction.

Calling Context:

Called to get the transaction status.

Parameters:

Takes no parameters.

Return Value:

EStatus.

Exceptions:

Throws no exceptions.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTransaction::~TTransaction

virtual ~ TTransaction ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy a TTransaction object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.