Class: TLockRequest

Declaration: CcrmStandardLockRequest.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

TStandardLockRequest

Purpose:

A base type for objects representing LockRequest.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

TStandardLockRequest. Deriving class may override Release function.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TLockRequest::GetState

virtual EState GetState () const

Interface Category:

API.

Purpose:

Gets the lock request state.

Calling Context:

None.

Parameters:

Takes no parameters.

Return Value:

The state of the request.

Exceptions:

Throws no exceptions.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLockRequest::~TLockRequest

virtual ~ TLockRequest ()

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.

Member Function: TLockRequest::TLockRequest

TLockRequest (TStandardTransaction & StandardTransaction, unsigned long objectId, unsigned long recId, ELockType LockType, ELockMode LockMode)

Interface Category:

API.

Purpose:

Instantiates TLockRequest base class.

Calling Context:

Called by TStandardLockRequest. Called indirectly by derived classes.

Parameters:

TStandardTransaction & Trans -The transaction in scope.
unsigned long objectId -The object's unique ID.
unsigned long recordid -The Record/Segment offset.
ELockType lt =kRead -The lock type.
ELockMode lm =kWait -The lock mode.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Member Function: TLockRequest::Release

virtual void Release ()

Interface Category:

API.

Purpose:

Releases an acquired lock.

Calling Context:

Called by the Resource Manager to release an acquired lock.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

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