Class: MLockable

Declaration: CcrmLockable.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

MRecoverable

Purpose:

A handle for a class that carries state information for a lockable entity.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: MLockable::MLockable

MLockable (unsigned long objectId, unsigned long hashvalue)

Interface Category:

API.

Purpose:

Constructor.

Calling Context:

Called by MRecoverable.

Parameters:

unsigned long objectId -The lockable object's ID.
unsigned long hashvalue -The lockable object's hash value.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: MLockable::~MLockable

virtual ~ MLockable ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an MLockable 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: MLockable::DoesMatch

virtual EAnswer DoesMatch (MLockable *) const

Interface Category:

API.

Purpose:

Compares itself with the object passed.

Calling Context:

Called by the lock table.

Parameters:

MLockable * -The object passed.

Return Value:

EAnswer.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: MLockable::GetId

unsigned long GetId () const

Interface Category:

API.

Purpose:

Gets the lock ID.

Calling Context:

Called by anyone who needs to know the lock ID of the lockable object and by TStandardLockRequest.

Parameters:

Takes no parameters.

Return Value:

The unsigned long lock ID.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: MLockable::GetHashValue

virtual unsigned long GetHashValue () const

Interface Category:

API.

Purpose:

Gets the hash value of the lockable object.

Calling Context:

Called by anyone who needs to know the hash value of the lockable object and by TStandardLockRequest.

Parameters:

Takes no parameters.

Return Value:

The unsigned long hash value.

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.