1.3.14 OcaLockManager

Class Hierarchy:

OcaRoot : OcaManager : OcaLockManager

class OcaLockManager : OcaManager

Optional object and device lock manager that supports mutex-type waits for locking things without causing race conditions.

• May be instantiated at most once in any device.

• If instantiated, object number must be 14 (decimal).

Properties:

static const OcaClassID ClassID = "1.3.14"

Number that uniquely identifies the class. Note that this differs from the object number, which identifies the instantiated object. This property is an override of the OcaRoot property.

This property has id 1.1.

static const OcaClassVersionNumber ClassVersion = 1

Identifies the interface version of the class. Any change to the class definition leads to a higher class version. This property is an override of the OcaRoot property.

This property has id 1.2.

Properties inherited from 1.3 OcaManager:

• OcaClassID OcaRoot::ClassID

• OcaClassVersionNumber OcaRoot::ClassVersion

• OcaBoolean OcaRoot::Lockable

• OcaLockState OcaRoot::LockState

• OcaONo OcaRoot::ObjectNumber

• OcaString OcaRoot::Role

• OcaClassID OcaManager::ClassID

• OcaClassVersionNumber OcaManager::ClassVersion

Methods:

OcaStatus LockWait(OcaONo target, OcaLockState type, OcaTimeInterval timeout)

Lock an object. returns when lock is set or timeout expires or AbortWaits(…) is called. A timeout value of zero requests an indefinite wait with no timeout.. Note: To lock an entire device, lock its Device Manager (ONo 1).

This method has id 3.1.

• target: Input parameter.

• type: Input parameter.

• timeout: Input parameter.

OcaStatus AbortWaits(OcaONo ONo)

Aborts all of this session’s waits on the given object.

This method has id 3.2.

• ONo: Input parameter.

Methods inherited from 1.3 OcaManager:

• OcaManager::GetClassIdentification

• OcaManager::GetLockable

• OcaManager::GetLockState

• OcaManager::GetRole

• OcaManager::SetLockNoWrite

• OcaManager::SetLockNoReadWrite

• OcaManager::Unlock