Top Description Fields Constructors Methods

com.github.benmanes.caffeine.cache

pack-priv final Class Pacer

Class Inheritance

extends Object

java.lang.Object
com.github.benmanes.caffeine.cache.Pacer

Static Imports

com.github.benmanes.caffeine.cache.Caffeine.ceilingPowerOfTwo, java.util.Objects.requireNonNull

A pacing scheduler that prevents executions from happening too frequently. Only one task may be scheduled at any given time, the earliest pending task takes precedence, and the delay may be increased if it is less than a tolerance threshold.

Author: [email protected] (Ben Manes)

Field Summary

Modifier and Type	Field and Description
pack-priv @Nullable Future<?>	future
pack-priv long	nextFireTime
pack-priv final Scheduler	scheduler
pack-priv static final long	TOLERANCE

Constructor Summary

Access	Constructor and Description
pack-priv	Pacer(Scheduler scheduler)

Method Summary

Modifier and Type	Method and Description
pack-priv long	calculateSchedule(long now, long delay, long scheduleAt) Returns the delay and sets the next fire time.
public void	cancel() Attempts to cancel execution of the scheduled task, if present.
public boolean	isScheduled() Returns if a task is scheduled to run.
pack-priv boolean	maySkip(long scheduleAt) Returns if the current fire time is sooner, or if it is later and within the tolerance limit.
public void	schedule(Executor executor, Runnable command, long now, long delay) Schedules the task, pacing the execution if occurring too often.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

future	back to summary
pack-priv @Nullable Future<?> future

nextFireTime	back to summary
pack-priv long nextFireTime

scheduler	back to summary
pack-priv final Scheduler scheduler

TOLERANCE	back to summary
pack-priv static final long TOLERANCE

Constructor Detail

Pacer	back to summary
pack-priv Pacer(Scheduler scheduler)

Method Detail

calculateSchedule	back to summary
pack-priv long calculateSchedule(long now, long delay, long scheduleAt) Returns the delay and sets the next fire time.

cancel	back to summary
public void cancel() Attempts to cancel execution of the scheduled task, if present.

isScheduled	back to summary
public boolean isScheduled() Returns if a task is scheduled to run.

maySkip	back to summary
pack-priv boolean maySkip(long scheduleAt) Returns if the current fire time is sooner, or if it is later and within the tolerance limit.

schedule	back to summary
public void schedule(Executor executor, Runnable command, long now, long delay) Schedules the task, pacing the execution if occurring too often.