Package org.infinispan.util.concurrent.locks

Interface PendingLockManager

All Known Implementing Classes:

DefaultPendingLockManager, NoOpPendingLockManager

public interface PendingLockManager

A manager that checks and waits for older topology transaction with conflicting keys.

Since:

8.0

Author:

Pedro Ruivo

Method Summary

Modifier and Type	Method	Description
long	awaitPendingTransactionsForAllKeys(TxInvocationContext<?> ctx, Collection<Object> keys, long time, TimeUnit unit)	Deprecated, for removal: This API element is subject to removal in a future version. Since 10.0, the blocking variants will be removed
long	awaitPendingTransactionsForKey(TxInvocationContext<?> ctx, Object key, long time, TimeUnit unit)	Deprecated, for removal: This API element is subject to removal in a future version. Since 10.0, the blocking variants will be removed
PendingLockPromise	checkPendingTransactionsForKey(TxInvocationContext<?> ctx, Object key, long time, TimeUnit unit)	Same as awaitPendingTransactionsForKey(TxInvocationContext, Object, long, TimeUnit) but non-blocking.
PendingLockPromise	checkPendingTransactionsForKeys(TxInvocationContext<?> ctx, Collection<Object> keys, long time, TimeUnit unit)	Same as awaitPendingTransactionsForAllKeys(TxInvocationContext, Collection, long, TimeUnit) but non-blocking.

Method Details

checkPendingTransactionsForKey

PendingLockPromise checkPendingTransactionsForKey(TxInvocationContext<?> ctx,
 Object key,
 long time,
 TimeUnit unit)

Same as awaitPendingTransactionsForKey(TxInvocationContext, Object, long, TimeUnit) but non-blocking.

Multiple invocations with the same transaction returns the same PendingLockPromise. For cleanup purposes, awaitPendingTransactionsForKey(TxInvocationContext, Object, long, TimeUnit) must be invoked afterwards.

Parameters:

ctx - the TxInvocationContext.

key - the key to check.

time - timeout.

unit - TimeUnit of time.

Returns:

a PendingLockPromise.

checkPendingTransactionsForKeys

PendingLockPromise checkPendingTransactionsForKeys(TxInvocationContext<?> ctx,
 Collection<Object> keys,
 long time,
 TimeUnit unit)

Same as awaitPendingTransactionsForAllKeys(TxInvocationContext, Collection, long, TimeUnit) but non-blocking.

Multiple invocations with the same transaction returns the same PendingLockPromise. For cleanup purposes, awaitPendingTransactionsForAllKeys(TxInvocationContext, Collection, long, TimeUnit) must be invoked afterwards.

Parameters:

ctx - the TxInvocationContext.

keys - the keys to check.

time - timeout.

unit - TimeUnit of time.

Returns:

a PendingLockPromise.

awaitPendingTransactionsForKey

@Deprecated(forRemoval=true)
long awaitPendingTransactionsForKey(TxInvocationContext<?> ctx,
 Object key,
 long time,
 TimeUnit unit)
                             throws InterruptedException

Deprecated, for removal: This API element is subject to removal in a future version.

Since 10.0, the blocking variants will be removed

It waits for any transaction with older topology id to complete that may have the lock for key acquired.

Parameters:

ctx - the TxInvocationContext.

key - the key to check.

time - timeout.

unit - TimeUnit of time.

Returns:

the remaining timeout.

Throws:

InterruptedException - if the thread is interrupted while waiting.

awaitPendingTransactionsForAllKeys

@Deprecated(forRemoval=true)
long awaitPendingTransactionsForAllKeys(TxInvocationContext<?> ctx,
 Collection<Object> keys,
 long time,
 TimeUnit unit)
                                 throws InterruptedException

Deprecated, for removal: This API element is subject to removal in a future version.

Since 10.0, the blocking variants will be removed

It waits for any transaction with older topology id to complete that may have the lock for any key in keys acquired.

Parameters:

ctx - the TxInvocationContext.

keys - the keys to check.

time - timeout.

unit - TimeUnit of time.

Returns:

the remaining timeout.

Throws:

InterruptedException - if the thread is interrupted while waiting.