Interface LockFactory

    • Method Detail

      • createCompatibilitySpace

        CompatibilitySpace createCompatibilitySpace​(LockOwner owner)
        Create an object which can be used as a compatibility space. A compatibility space object can only be used in the LockFactory that created it.
        Parameters:
        owner - the owner of the compatibility space (typically a transaction object). Might be null.
        Returns:
        an object which represents a compatibility space
      • lockObject

        boolean lockObject​(CompatibilitySpace compatibilitySpace,
                           java.lang.Object group,
                           Lockable ref,
                           java.lang.Object qualifier,
                           int timeout)
                    throws StandardException
        Lock an object within a compatibility space and associate the lock with a group object, waits up to timeout milli-seconds for the object to become unlocked. A timeout of 0 means do not wait for the lock to be unlocked. Note the actual time waited is approximate.

        A compatibility space in an space where lock requests are assumed to be compatible and granted by the lock manager if the trio {compatibilitySpace, ref, qualifier} are equal (i.e. reference equality for qualifier and compatibilitySpace, equals() method for ref). Granted by the lock manager means that the Lockable object may or may not be queried to see if the request is compatible.
        A compatibility space is not assumed to be owned by a single thread.

        Parameters:
        compatibilitySpace - object defining compatibility space
        group - handle of group, must be private to a thread.
        ref - reference to object to be locked
        qualifier - A qualification of the request.
        timeout - the maximum time to wait in milliseconds, LockFactory.NO_WAIT means don't wait.
        Returns:
        true if the lock was obtained, false if timeout is equal to LockFactory.NO_WAIT and the lock could not be granted.
        Throws:
        StandardException - if a deadlock has occurred (message id will be LockFactory.Deadlock), or if the wait for the lock timed out (message id will be LockFactory.TimeOut), or if another thread interrupted this thread while it was waiting for the lock (this will be a StandardException with a nested InterruptedException, and the message id will be LockFactory.InterruptedExceptionId), or if any other error occurs when locking the object
      • unlock

        int unlock​(CompatibilitySpace compatibilitySpace,
                   java.lang.Object group,
                   Lockable ref,
                   java.lang.Object qualifier)
        Unlock a single lock on a single object held within this compatibility space and locked with the supplied qualifier.
        Parameters:
        compatibilitySpace - object defining compatibility space
        group - handle of group.
        ref - Reference to object to be unlocked.
        qualifier - qualifier of lock to be unlocked
        Returns:
        number of locks released (one or zero).
      • unlockGroup

        void unlockGroup​(CompatibilitySpace compatibilitySpace,
                         java.lang.Object group)
        Unlock all locks in a group.
        Parameters:
        compatibilitySpace - object defining compatibility space
        group - handle of group that objects were locked with.
      • unlockGroup

        void unlockGroup​(CompatibilitySpace compatibilitySpace,
                         java.lang.Object group,
                         Matchable key)
        Unlock all locks on a group that match the passed in value.
      • transfer

        void transfer​(CompatibilitySpace compatibilitySpace,
                      java.lang.Object oldGroup,
                      java.lang.Object newGroup)
        Transfer a set of locks from one group to another.
      • anyoneBlocked

        boolean anyoneBlocked()
        Returns true if locks held by anyone are blocking anyone else
      • areLocksHeld

        boolean areLocksHeld​(CompatibilitySpace compatibilitySpace,
                             java.lang.Object group)
        Return true if locks are held in this compatibility space and this group.
        Parameters:
        group - handle of group that objects were locked with.
      • areLocksHeld

        boolean areLocksHeld​(CompatibilitySpace compatibilitySpace)
        Return true if locks are held in this compatibility space.
      • zeroDurationlockObject

        boolean zeroDurationlockObject​(CompatibilitySpace compatibilitySpace,
                                       Lockable ref,
                                       java.lang.Object qualifier,
                                       int timeout)
                                throws StandardException
        Lock an object with zero duration within a compatibility space, waits up to timeout milli-seconds for the object to become unlocked. A timeout of 0 means do not wait for the lock to be unlocked. Note the actual time waited is approximate.

        Zero duration means the lock is released as soon as it is obtained.

        A compatibility space in an space where lock requests are assumed to be compatible and granted by the lock manager if the trio {compatibilitySpace, ref, qualifier} are equal (i.e. reference equality for qualifier and compatibilitySpace, equals() method for ref). Granted by the lock manager means that the Lockable object may or may not be queried to see if the request is compatible.
        A compatibility space is not assumed to be owned by a single thread.

        Parameters:
        compatibilitySpace - object defining compatibility space
        ref - reference to object to be locked
        qualifier - A qualification of the request.
        timeout - the maximum time to wait in milliseconds, LockFactory.NO_WAIT means don't wait.
        Returns:
        true if the lock was obtained, false if timeout is equal to LockFactory.NO_WAIT and the lock could not be granted.
        Throws:
        StandardException - if a deadlock has occurred (message id will be LockFactory.Deadlock), or if the wait for the lock timed out (message id will be LockFactory.TimeOut), or if another thread interrupted this thread while it was waiting for the lock (this will be a StandardException with a nested InterruptedException, and the message id will be LockFactory.InterruptedExceptionId), or if any other error occurs when locking the object
      • isLockHeld

        boolean isLockHeld​(CompatibilitySpace compatibilitySpace,
                           java.lang.Object group,
                           Lockable ref,
                           java.lang.Object qualifier)
        Check to see if a specific lock is held.
      • getWaitTimeout

        int getWaitTimeout()
        Get the lock timeout in milliseconds. A negative number means that there is no timeout.
      • setLimit

        void setLimit​(CompatibilitySpace compatibilitySpace,
                      java.lang.Object group,
                      int limit,
                      Limit callback)
        Install a limit that is called when the size of the group exceeds the required limit.
        It is not guaranteed that the callback method (Limit.reached) is called as soon as the group size exceeds the given limit. If the callback method does not result in a decrease in the number of locks held then the lock factory implementation may delay calling the method again. E.g. with a limit of 500 and a reached() method that does nothing, may result in the call back method only being called when the group size reaches 550.
        Only one limit may be in place for a group at any time.
        See Also:
        Limit
      • clearLimit

        void clearLimit​(CompatibilitySpace compatibilitySpace,
                        java.lang.Object group)
        Clear a limit set by setLimit.
      • makeVirtualLockTable

        java.util.Enumeration makeVirtualLockTable()
        Make a virtual lock table for diagnostics.