Package com.yahoo.concurrent.classlock

Class ClassLocking

java.lang.Object

com.yahoo.concurrent.classlock.ClassLocking

public class ClassLocking
extends Object

This class is injectable to Vespa plugins and is used to acquire locks cross application deployments.

Author:

valerijf

Constructor Summary

Constructors

Constructor	Description
ClassLocking()

Method Summary

Modifier and Type	Method	Description
void	interrupt()	Notifies lockWhile(java.lang.Class<?>, java.util.function.BooleanSupplier) to check the interrupt condition
ClassLock	lock(Class<?> clazz)	Locks key.
ClassLock	lockWhile(Class<?> clazz, BooleanSupplier interruptCondition)	Locks key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ClassLocking

public ClassLocking()

Method Details

lock

public ClassLock lock(Class<?> clazz)

Locks key. This will block until the key is acquired. Users of this must close any lock acquired.

lockWhile

public ClassLock lockWhile(Class<?> clazz,
 BooleanSupplier interruptCondition)

Locks key. This will block until the key is acquired or the interrupt condition is no longer true. Condition is only checked at the start, everytime a lock is released and when interrupt() is called. Users of this must close any lock acquired.

Throws:

LockInterruptException - if interruptCondition returned false before the lock could be acquired

interrupt

public void interrupt()

Notifies lockWhile(java.lang.Class<?>, java.util.function.BooleanSupplier) to check the interrupt condition