System::getQueuedLocks Method

Product Information > JADE Object Manager Guide > Chapter 4 - JADE System Instrumentation and Diagnosis > SystemgetQueuedLocks Method

System::getQueuedLocks Method

getQueuedLocks(locks:      LockArray input; 
               maxEntries: Integer);

The System class getQueuedLocks method is similar to the System class getObjectLockProcesses and getLocks methods, but it includes only the lock requests that are waiting for objects to be unlocked by the processes that currently have them locked.

The value of the maxEntries parameter specifies the maximum number of entries to be inserted into the array specified by the locks parameter. Entries are inserted in no particular order.

Lock objects returned in the locks parameter can have lock entries in the array that have the Lock class lockedBy property set to null if the lock request is still waiting to be processed in the lock queue.

When this occurs, the process that caused the lock request to be queued has already released it but because of high activity on the executing node, the lock request has not been retried.

For an example of the use of this method, see the System class getQueuedLocks method in Volume 2 of the JADE Encyclopaedia of Classes.