org.elasticsearch.index.shard

Class IndexShardOperationsLock

java.lang.Object

org.elasticsearch.index.shard.IndexShardOperationsLock

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class IndexShardOperationsLock
extends java.lang.Object
implements java.io.Closeable

Constructor Summary

Constructors

Constructor and Description
IndexShardOperationsLock(ShardId shardId, org.apache.logging.log4j.Logger logger, ThreadPool threadPool)

Method Summary

Modifier and Type	Method and Description
void	acquire(ActionListener<Releasable> onAcquired, java.lang.String executorOnDelay, boolean forceExecution) Acquires a permit whenever permit acquisition is not blocked.
void	blockOperations(long timeout, java.util.concurrent.TimeUnit timeUnit, java.lang.Runnable onBlocked) Wait for in-flight operations to finish and executes onBlocked under the guarantee that no new operations are started.
void	close()
int	getActiveOperationsCount()

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexShardOperationsLock

public IndexShardOperationsLock(ShardId shardId,
                                org.apache.logging.log4j.Logger logger,
                                ThreadPool threadPool)

Method Detail

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

blockOperations

public void blockOperations(long timeout,
                            java.util.concurrent.TimeUnit timeUnit,
                            java.lang.Runnable onBlocked)
                     throws java.lang.InterruptedException,
                            java.util.concurrent.TimeoutException

Wait for in-flight operations to finish and executes onBlocked under the guarantee that no new operations are started. Queues operations that are occurring in the meanwhile and runs them once onBlocked has executed.

Parameters:

timeout - the maximum time to wait for the in-flight operations block

timeUnit - the time unit of the timeout argument

onBlocked - the action to run once the block has been acquired

Throws:

java.lang.InterruptedException - if calling thread is interrupted

java.util.concurrent.TimeoutException - if timed out waiting for in-flight operations to finish

IndexShardClosedException - if operation lock has been closed

acquire

public void acquire(ActionListener<Releasable> onAcquired,
                    java.lang.String executorOnDelay,
                    boolean forceExecution)

Acquires a permit whenever permit acquisition is not blocked. If the permit is directly available, the provided ActionListener will be called on the calling thread. During calls of blockOperations(long, TimeUnit, Runnable), permit acquisition can be delayed. The ActionListener.onResponse(Object) method will then be called using the provided executor once operations are no longer blocked. Note that the executor will not be used for ActionListener.onFailure(Exception) calls. Those will run directly on the calling thread, which in case of delays, will be a generic thread. Callers should thus make sure that the ActionListener.onFailure(Exception) method provided here only contains lightweight operations.

Parameters:

onAcquired - ActionListener that is invoked once acquisition is successful or failed

executorOnDelay - executor to use for the possibly delayed ActionListener.onResponse(Object) call

forceExecution - whether the runnable should force its execution in case it gets rejected

getActiveOperationsCount

public int getActiveOperationsCount()