Class AbstractAsyncTask
org.elasticsearch.common.util.concurrent.AbstractAsyncTask
- All Implemented Interfaces:
,
,
public abstract class AbstractAsyncTask
extends
implements ,
A base class for tasks that need to repeat.
-
Constructor Summary
ModifierConstructorDescriptionprotected
AbstractAsyncTask(org.apache.logging.log4j.Logger logger, ThreadPool threadPool, org.elasticsearch.core.TimeValue interval, boolean autoReschedule)
-
Method Summary
Modifier and TypeMethodDescriptionvoid
cancel()
Cancel any scheduled run, but do not prevent subsequent restarts.void
close()
Cancel any scheduled runorg.elasticsearch.core.TimeValue
protected
Use the same threadpool by default.boolean
isClosed()
boolean
protected abstract boolean
Test any external conditions that determine whether the task should be scheduled.void
Schedule the task to run after the configured interval if it is not closed and any further conditions imposed by derived classes are met.void
run()
protected abstract void
void
setInterval(org.elasticsearch.core.TimeValue interval)
Change the interval between runs.Methods inherited from class java.lang.
, , , , , , , , , ,
-
Constructor Details
-
AbstractAsyncTask
protected AbstractAsyncTask(org.apache.logging.log4j.Logger logger, ThreadPool threadPool, org.elasticsearch.core.TimeValue interval, boolean autoReschedule)
-
-
Method Details
-
setInterval
public void setInterval(org.elasticsearch.core.TimeValue interval)Change the interval between runs. If a future run is scheduled then this will reschedule it.- Parameters:
interval
- The new interval between runs.
-
getInterval
public org.elasticsearch.core.TimeValue getInterval() -
mustReschedule
protected abstract boolean mustReschedule()Test any external conditions that determine whether the task should be scheduled. This method does *not* need to test if the task is closed, as being closed automatically prevents scheduling.- Returns:
- Should the task be scheduled to run?
-
rescheduleIfNecessary
public void rescheduleIfNecessary()Schedule the task to run after the configured interval if it is not closed and any further conditions imposed by derived classes are met. Any previously scheduled invocation is cancelled. -
isScheduled
public boolean isScheduled() -
cancel
public void cancel()Cancel any scheduled run, but do not prevent subsequent restarts. -
close
public void close()Cancel any scheduled run- Specified by:
in interface
- Specified by:
in interface
-
isClosed
public boolean isClosed() -
run
public final void run()- Specified by:
in interface
-
runInternal
protected abstract void runInternal() -
getThreadPool
protected getThreadPool()Use the same threadpool by default. Derived classes can change this if required.
-