Package com.inductiveautomation.historian.gateway.api.util

Class ReadWriteLockExecutor

java.lang.Object

com.inductiveautomation.historian.gateway.api.util.ReadWriteLockExecutor

public class ReadWriteLockExecutor
extends Object

Utility class for managing and executing operations within read and write locks. Provides convenience methods for working with ReentrantReadWriteLock, allowing execution of actions or computation of results under various lock conditions.

Constructor Summary

Constructors

Constructor	Description
ReadWriteLockExecutor()
ReadWriteLockExecutor(boolean fair)
ReadWriteLockExecutor(ReentrantReadWriteLock lock)

Method Summary

Modifier and Type	Method	Description
ReentrantReadWriteLock	getUnderlyingLock()	Returns the underlying ReentrantReadWriteLock for advanced use cases.
Lock	readLock()	Returns the read lock for advanced use cases.
<E extends Exception> boolean	tryWithReadLock(long timeout, TimeUnit unit, CheckedRunnable<E> action)	Attempts to execute the given runnable within a read lock with a timeout.
<T, E extends Exception> Optional<T>	tryWithReadLock(long timeout, TimeUnit unit, CheckedSupplier<T,E> action)	Attempts to execute the given supplier within a read lock with a timeout.
<E extends Exception> boolean	tryWithWriteLock(long timeout, TimeUnit unit, CheckedRunnable<E> action)	Attempts to execute the given runnable within a write lock with a timeout.
<T, E extends Exception> Optional<T>	tryWithWriteLock(long timeout, TimeUnit unit, CheckedSupplier<T,E> action)	Attempts to execute the given supplier within a write lock with a timeout.
<E extends Exception> void	withReadLock(CheckedRunnable<E> action)	Executes the given runnable within a read lock.
<T, E extends Exception> T	withReadLock(CheckedSupplier<T,E> action)	Executes the given supplier within a read lock, returning its result.
<E extends Exception> void	withReadLockInterruptibly(CheckedRunnable<E> action)	Executes the given runnable within an interruptible read lock.
<T, E extends Exception> T	withReadLockInterruptibly(CheckedSupplier<T,E> action)	Executes the given supplier within an interruptible read lock, returning its result.
<E extends Exception> void	withWriteLock(CheckedRunnable<E> action)	Executes the given runnable within a write lock.
<T, E extends Exception> T	withWriteLock(CheckedSupplier<T,E> action)	Executes the given supplier within a write lock, returning its result.
<E extends Exception> void	withWriteLockInterruptibly(CheckedRunnable<E> action)	Executes the given runnable within an interruptible write lock.
<T, E extends Exception> T	withWriteLockInterruptibly(CheckedSupplier<T,E> action)	Executes the given supplier within an interruptible write lock, returning its result.
Lock	writeLock()	Returns the write lock for advanced use cases.

Methods inherited from class java.lang.Object

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

Constructor Details

ReadWriteLockExecutor

public ReadWriteLockExecutor()

ReadWriteLockExecutor

public ReadWriteLockExecutor(boolean fair)

ReadWriteLockExecutor

public ReadWriteLockExecutor(ReentrantReadWriteLock lock)

Method Details

withReadLock

public <T,
E extends Exception> T withReadLock(CheckedSupplier<T,E> action)
                                       throws E

Executes the given supplier within a read lock, returning its result.

Throws:

E extends Exception

withReadLock

public <E extends Exception> void withReadLock(CheckedRunnable<E> action)
                                        throws E

Executes the given runnable within a read lock.

Throws:

E extends Exception

withWriteLock

public <T,
E extends Exception> T withWriteLock(CheckedSupplier<T,E> action)
                                        throws E

Executes the given supplier within a write lock, returning its result.

Throws:

E extends Exception

withWriteLock

public <E extends Exception> void withWriteLock(CheckedRunnable<E> action)
                                         throws E

Executes the given runnable within a write lock.

Throws:

E extends Exception

tryWithReadLock

public <T,
E extends Exception> Optional<T> tryWithReadLock(long timeout,
 TimeUnit unit,
 CheckedSupplier<T,E> action)
                                                    throws E,
InterruptedException

Attempts to execute the given supplier within a read lock with a timeout. Returns an Optional containing the result if the lock was acquired, or empty if the timeout elapsed.

Throws:

E extends Exception

InterruptedException

tryWithReadLock

public <E extends Exception> boolean tryWithReadLock(long timeout,
 TimeUnit unit,
 CheckedRunnable<E> action)
                                              throws E,
InterruptedException

Attempts to execute the given runnable within a read lock with a timeout. Returns true if the lock was acquired and action executed, false if the timeout elapsed.

Throws:

E extends Exception

InterruptedException

tryWithWriteLock

public <T,
E extends Exception> Optional<T> tryWithWriteLock(long timeout,
 TimeUnit unit,
 CheckedSupplier<T,E> action)
                                                     throws E,
InterruptedException

Attempts to execute the given supplier within a write lock with a timeout. Returns an Optional containing the result if the lock was acquired, or empty if the timeout elapsed.

Throws:

E extends Exception

InterruptedException

tryWithWriteLock

public <E extends Exception> boolean tryWithWriteLock(long timeout,
 TimeUnit unit,
 CheckedRunnable<E> action)
                                               throws E,
InterruptedException

Attempts to execute the given runnable within a write lock with a timeout. Returns true if the lock was acquired and action executed, false if the timeout elapsed.

Throws:

E extends Exception

InterruptedException

withReadLockInterruptibly

public <T,
E extends Exception> T withReadLockInterruptibly(CheckedSupplier<T,E> action)
                                                    throws E,
InterruptedException

Executes the given supplier within an interruptible read lock, returning its result.

Throws:

E extends Exception

InterruptedException

withReadLockInterruptibly

public <E extends Exception> void withReadLockInterruptibly(CheckedRunnable<E> action)
                                                     throws E,
InterruptedException

Executes the given runnable within an interruptible read lock.

Throws:

E extends Exception

InterruptedException

withWriteLockInterruptibly

public <T,
E extends Exception> T withWriteLockInterruptibly(CheckedSupplier<T,E> action)
                                                     throws E,
InterruptedException

Executes the given supplier within an interruptible write lock, returning its result.

Throws:

E extends Exception

InterruptedException

withWriteLockInterruptibly

public <E extends Exception> void withWriteLockInterruptibly(CheckedRunnable<E> action)
                                                      throws E,
InterruptedException

Executes the given runnable within an interruptible write lock.

Throws:

E extends Exception

InterruptedException

readLock

public Lock readLock()

Returns the read lock for advanced use cases.

writeLock

public Lock writeLock()

Returns the write lock for advanced use cases.

getUnderlyingLock

public ReentrantReadWriteLock getUnderlyingLock()

Returns the underlying ReentrantReadWriteLock for advanced use cases.