org.cache2k.core

Class TimingHandler<K,V>

java.lang.Object

org.cache2k.core.TimingHandler<K,V>

public abstract class TimingHandler<K,V>
extends Object

Encapsulates logic for expiry times calculation and timer handling.

Author:

Jens Wilke

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TimingHandler.Tunable

Constructor Summary

Constructors

Constructor and Description
TimingHandler()

Method Summary

Modifier and Type	Method and Description
abstract long	cacheExceptionUntil(Entry<K,V> e, org.cache2k.integration.ExceptionInformation inf) Delegated to the resilience policy
abstract long	calculateNextRefreshTime(Entry<K,V> e, V v, long _loadTime) Calculates the expiry time for a value that was just loaded or inserted into the cache.
void	cancelExpiryTimer(Entry<K,V> e) Cancel the timer on the entry, if a timer was set.
void	close()
void	init(InternalCache<K,V> c) Initialize timer, if needed.
static <K,V> TimingHandler<K,V>	of(InternalClock _clock, org.cache2k.configuration.Cache2kConfiguration<K,V> cfg)
void	reset() Cancel all timer events, and re-initialize timer
void	scheduleFinalTimerForSharpExpiry(Entry<K,V> e) Schedule second timer event for the expiry tie if sharp expiry is switched on.
void	shutdown() Cancels all pending timer events.
boolean	startRefreshProbationTimer(Entry<K,V> e, long _nextRefreshTime) Start timer for expiring an entry on the separate refresh hash.
long	stopStartTimer(long _expiryTime, Entry<K,V> e) Convert expiry value to the entry field value, essentially maps 0 to Entry.EXPIRED since 0 is a virgin entry.
abstract long	suppressExceptionUntil(Entry<K,V> e, org.cache2k.integration.ExceptionInformation inf) Delegated to the resilience policy

Methods inherited from class java.lang.Object

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

Constructor Detail

TimingHandler

public TimingHandler()

Method Detail

of

public static <K,V> TimingHandler<K,V> of(InternalClock _clock,
                                          org.cache2k.configuration.Cache2kConfiguration<K,V> cfg)

init

public void init(InternalCache<K,V> c)

Initialize timer, if needed.

reset

public void reset()

Cancel all timer events, and re-initialize timer

shutdown

public void shutdown()

Cancels all pending timer events.

close

public void close()

calculateNextRefreshTime

public abstract long calculateNextRefreshTime(Entry<K,V> e,
                                              V v,
                                              long _loadTime)

Calculates the expiry time for a value that was just loaded or inserted into the cache.

Parameters:

e - The entry, filled with the previous value if there is a value present alreay.

v - The new value or an exception wrapped in ExceptionWrapper

_loadTime - the time immediately before the load started

Returns:

Point in time when the entry should expire. Meaning identical to ExpiryPolicy.calculateExpiryTime(Object, Object, long, CacheEntry)

suppressExceptionUntil

public abstract long suppressExceptionUntil(Entry<K,V> e,
                                            org.cache2k.integration.ExceptionInformation inf)

Delegated to the resilience policy

See Also:

ResiliencePolicy.suppressExceptionUntil(K, org.cache2k.integration.ExceptionInformation, org.cache2k.CacheEntry<K, V>)

cacheExceptionUntil

public abstract long cacheExceptionUntil(Entry<K,V> e,
                                         org.cache2k.integration.ExceptionInformation inf)

Delegated to the resilience policy

See Also:

ResiliencePolicy.retryLoadAfter(K, org.cache2k.integration.ExceptionInformation)

stopStartTimer

public long stopStartTimer(long _expiryTime,
                           Entry<K,V> e)

Convert expiry value to the entry field value, essentially maps 0 to Entry.EXPIRED since 0 is a virgin entry. Restart the timer if needed.

Parameters:

_expiryTime - calculated expiry time

Returns:

sanitized nextRefreshTime for storage in the entry.

startRefreshProbationTimer

public boolean startRefreshProbationTimer(Entry<K,V> e,
                                          long _nextRefreshTime)

Start timer for expiring an entry on the separate refresh hash.

cancelExpiryTimer

public void cancelExpiryTimer(Entry<K,V> e)

Cancel the timer on the entry, if a timer was set.

scheduleFinalTimerForSharpExpiry

public void scheduleFinalTimerForSharpExpiry(Entry<K,V> e)

Schedule second timer event for the expiry tie if sharp expiry is switched on.