Package org.elasticsearch.index.shard

Class RefreshListeners

java.lang.Object

org.elasticsearch.index.shard.RefreshListeners

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.lucene.search.ReferenceManager.RefreshListener

public final class RefreshListeners
extends Object
implements org.apache.lucene.search.ReferenceManager.RefreshListener, Closeable

Allows for the registration of listeners that are called when a change becomes visible for search. This functionality is exposed from IndexShard but kept here so it can be tested without standing up the entire thing. When Closeable.close()d it will no longer accept listeners and flush any existing listeners.

Constructor Summary

Constructors

Constructor	Description
RefreshListeners(IntSupplier getMaxRefreshListeners, Runnable forceRefresh, org.apache.logging.log4j.Logger logger, ThreadContext threadContext, MeanMetric refreshMetric)

Method Summary

Modifier and Type	Method	Description
boolean	addOrNotify(long checkpoint, ActionListener<Void> listener)	Add a listener for refreshes, calling it immediately if the location is already visible.
boolean	addOrNotify(Translog.Location location, Consumer<Boolean> listener)	Add a listener for refreshes, calling it immediately if the location is already visible.
void	afterRefresh(boolean didRefresh)
void	beforeRefresh()
void	close()
org.elasticsearch.core.Releasable	forceRefreshes()	Force-refreshes newly added listeners and forces a refresh if there are currently listeners registered.
int	pendingCount()	The total number of pending listeners.
boolean	refreshNeeded()	Returns true if there are pending listeners.
void	setCurrentProcessedCheckpointSupplier(LongSupplier processedCheckpointSupplier)	Setup the engine used to find the last processed sequence number checkpoint.
void	setCurrentRefreshLocationSupplier(Supplier<Translog.Location> currentRefreshLocationSupplier)	Setup the translog used to find the last refreshed location.
void	setMaxIssuedSeqNoSupplier(LongSupplier maxIssuedSeqNoSupplier)	Setup the engine used to find the max issued seqNo.

Methods inherited from class java.lang.Object

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

Constructor Details

RefreshListeners

public RefreshListeners(IntSupplier getMaxRefreshListeners,
 Runnable forceRefresh,
 org.apache.logging.log4j.Logger logger,
 ThreadContext threadContext,
 MeanMetric refreshMetric)

Method Details

forceRefreshes

public org.elasticsearch.core.Releasable forceRefreshes()

Force-refreshes newly added listeners and forces a refresh if there are currently listeners registered. See refreshForcers.

addOrNotify

public boolean addOrNotify(Translog.Location location,
 Consumer<Boolean> listener)

Add a listener for refreshes, calling it immediately if the location is already visible. If this runs out of listener slots then it forces a refresh and calls the listener immediately as well.

Parameters:

location - the location to listen for

listener - for the refresh. Called with true if registering the listener ran it out of slots and forced a refresh. Called with false otherwise.

Returns:

did we call the listener (true) or register the listener to call later (false)?

addOrNotify

public boolean addOrNotify(long checkpoint,
 ActionListener<Void> listener)

Add a listener for refreshes, calling it immediately if the location is already visible. If this runs out of listener slots then it fails the listener immediately. The checkpoint cannot be greater than the processed local checkpoint. This method does not respect the forceRefreshes state. It will NEVER force a refresh on the calling thread. Instead, it will simply add listeners or rejected them if too many listeners are already waiting.

Parameters:

checkpoint - the seqNo checkpoint to listen for

listener - for the refresh.

Returns:

did we call the listener (true) or register the listener to call later (false)?

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

refreshNeeded

public boolean refreshNeeded()

Returns true if there are pending listeners.

pendingCount

public int pendingCount()

The total number of pending listeners.

setCurrentRefreshLocationSupplier

public void setCurrentRefreshLocationSupplier(Supplier<Translog.Location> currentRefreshLocationSupplier)

Setup the translog used to find the last refreshed location.

setCurrentProcessedCheckpointSupplier

public void setCurrentProcessedCheckpointSupplier(LongSupplier processedCheckpointSupplier)

Setup the engine used to find the last processed sequence number checkpoint.

setMaxIssuedSeqNoSupplier

public void setMaxIssuedSeqNoSupplier(LongSupplier maxIssuedSeqNoSupplier)

Setup the engine used to find the max issued seqNo.

beforeRefresh

public void beforeRefresh()
                   throws IOException

Specified by:

beforeRefresh in interface org.apache.lucene.search.ReferenceManager.RefreshListener

Throws:

IOException

afterRefresh

public void afterRefresh(boolean didRefresh)
                  throws IOException

Specified by:

afterRefresh in interface org.apache.lucene.search.ReferenceManager.RefreshListener

Throws:

IOException