Class: TStandardLockRequest

Declaration: CcrmStandardLockRequest.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TLockRequest

Inherited By:

None.

Purpose:

Represents a lock request on a lockable object.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None. TStandardLockRequest should not be overridden.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TStandardLockRequest::TStandardLockRequest

TStandardLockRequest (TStandardTransaction & Trans, MLockable * Object, ELockType lt =kRead, ELockMode lm =kWait)
TStandardLockRequest (TStandardTransaction & Trans, MLockable * ObjectAlias, unsigned long offset, ELockType lt =kRead, ELockMode lm =kWait)

Interface Category:

API.

Purpose:

Constructor for an object lock request.
Constructor for a partial lock request.

Calling Context:

Called to acquire lock on the object.
Called to acquire lock on a Record or Segment of an object.

Parameters:

TStandardTransaction & Trans -The transaction in scope.
MLockable * Object -The lockable object.
ELockType lt =kRead -The lock type.
ELockMode lm =kWait -The lock mode.
TStandardTransaction & Trans -The transaction in scope.
MLockable * ObjectAlias -The lockable object.
unsigned long offset -The Record/Segment offset.
ELockType lt =kRead -The lock type.
ELockMode lm =kWait -The lock mode.

Return Value:

None.

Exceptions:

Throws TInvalidTransaction when the transaction in scope requests none compatible lock type (for example, Read transaction requesting WriteLock). Passes all other exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardLockRequest::~TStandardLockRequest

~ TStandardLockRequest ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no 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.