Package org.elasticsearch.index.shard

Class RefreshListeners

java.lang.Object

org.elasticsearch.index.shard.RefreshListeners

All Implemented Interfaces:

Closeable, AutoCloseable, ReferenceManager.RefreshListener

public final class RefreshListeners
extends Object
implements 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, Executor listenerExecutor, org.apache.logging.log4j.Logger logger, ThreadContext threadContext, MeanMetric refreshMetric)

Method Summary

Modifier and Type	Method	Description
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)	Called after the attempted refresh; if the refresh did open a new reference then didRefresh will be true and ReferenceManager.acquire() is guaranteed to return the new reference.
void	beforeRefresh()	Called right before a refresh attempt starts.
void	close()
Releasable	forceRefreshes()	Force-refreshes newly added listeners and forces a refresh if there are currently listeners registered.
int	pendingCount()	The number of pending listeners.
boolean	refreshNeeded()	Returns true if there are pending listeners.
void	setCurrentRefreshLocationSupplier(Supplier<Translog.Location> currentRefreshLocationSupplier)	Setup the translog used to find the last refreshed location.

Methods inherited from class java.lang.Object

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

Constructor Detail

RefreshListeners

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

Method Detail

forceRefreshes

public 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)?

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 number of pending listeners.

setCurrentRefreshLocationSupplier

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

Setup the translog used to find the last refreshed location.

beforeRefresh

public void beforeRefresh()
                   throws IOException

Description copied from interface: ReferenceManager.RefreshListener

Called right before a refresh attempt starts.

Specified by:

beforeRefresh in interface ReferenceManager.RefreshListener

Throws:

IOException

afterRefresh

public void afterRefresh(boolean didRefresh)
                  throws IOException

Description copied from interface: ReferenceManager.RefreshListener

Called after the attempted refresh; if the refresh did open a new reference then didRefresh will be true and ReferenceManager.acquire() is guaranteed to return the new reference.

Specified by:

afterRefresh in interface ReferenceManager.RefreshListener

Throws:

IOException