org.cache2k.impl

Class ClockCache<K,T>

java.lang.Object

org.cache2k.impl.BaseCache<E,K,T>

org.cache2k.impl.LockFreeCache<org.cache2k.impl.ClockCache.Entry,K,T>

org.cache2k.impl.ClockCache<K,T>

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<CacheEntry<K,T>>, Cache<K,T>, CacheSource<K,T>, CanCheckIntegrity, KeyValueSource<K,T>

public class ClockCache<K,T>
extends LockFreeCache<org.cache2k.impl.ClockCache.Entry,K,T>

Straight forward CLOCK implementation. This is probably the simplest eviction algorithm around. Interestingly it produces good results.

Author:

Jens Wilke; created: 2013-12-01

Nested Class Summary

Nested classes/interfaces inherited from class org.cache2k.impl.BaseCache

BaseCache.Info, BaseCache.MyTimerTask, BaseCache.Tunable

Field Summary

Fields inherited from class org.cache2k.impl.BaseCache

bulkCacheSource, bulkGetCnt, clearedTime, entryExpiryCalculator, evictedButInHashCnt, evictedCnt, evictionNeeded, exceptionExpiryCalculator, exceptionMaxLinger, experimentalBulkCacheSource, expiredKeptCnt, expiredRemoveCnt, fetchButHitCnt, fetchCnt, fetchExceptionCnt, fetchMillis, hashSeed, info, internalExceptionCnt, keyMutationCount, keyType, loadHitCnt, loadMissCnt, loadNonFreshAndFetchedCnt, loadNonFreshCnt, lock, mainHash, mainHashCtrl, manager, maximumBulkFetchSize, maxLinger, maxSize, name, newEntryCnt, peekHitNotFreshCnt, peekMissCnt, putCnt, putNewEntryCnt, refreshCnt, refreshHash, refreshHashCtrl, refreshHitCnt, refreshPool, refreshSubmitFailedCnt, removedCnt, shutdownInitiated, shutdownWaitFuture, source, startedTime, storage, suppressedExceptionCnt, timer, timerCancelCount, timerService, touchedTime, TUNABLE, valueType, virginEvictCnt, waitForClear

Constructor Summary

Constructors

Constructor and Description
ClockCache()

Method Summary

Methods

Modifier and Type	Method and Description
protected org.cache2k.impl.ClockCache.Entry	findEvictionCandidate() Run to evict an entry.
protected String	getExtraStatistics()
long	getHitCnt()
protected IntegrityState	getIntegrityState()
protected void	initializeHeapCache()
protected void	insertIntoReplacementList(org.cache2k.impl.ClockCache.Entry e) New cache entry, put it in the replacement algorithm structure
protected org.cache2k.impl.ClockCache.Entry	newEntry() Entry object factory.
protected void	recordHit(org.cache2k.impl.ClockCache.Entry e) Record an entry hit.
protected void	removeEntryFromReplacementList(org.cache2k.impl.ClockCache.Entry e)

Methods inherited from class org.cache2k.impl.LockFreeCache

lookupEntryUnsynchronized, lookupOrNewEntrySynchronized

Methods inherited from class org.cache2k.impl.BaseCache

calcNextRefreshTime, calculateHashEntryCount, checkClosed, checkCyclicListIntegrity, checkForGhost, checkIntegrity, clear, clearLocalCache, clearTimingStatistics, close, conditionallyStartProcess, contains, destroy, evictEventually, expireEntry, fetch, fetchFromSource, fetchWithStorage, flush, get, getAll, getAll, getBulk, getCompleteName, getCyclicListEntryCount, getEntry, getEntryInternal, getExpiredCnt, getFetchesBecauseOfNewEntries, getFetchesInFlight, getInfo, getLatestInfo, getListEntryCount, getLocalSize, getLog, getName, getStorage, getTotalEntryCount, hasBackgroundRefreshAndServesExpiredValues, hasKeepAfterExpired, hasSharpTimeout, hasSuppressExceptions, init, insert, insert, insertAfterHeadCyclicList, insertEntryFromStorage, insertEntryFromStorage, insertFetched, insertInList, insertIntoHeadCyclicList, insertIntoTailCyclicList, insertOnPut, isClosed, iterateAllHeapEntries, iterateLocalAndStorage, iterator, lockAndRunForPurge, lookupEntry, lookupEntrySynchronized, modifiedHash, moveToFront, newEntry, peek, peekEntry, peekEntryInternal, prefetch, prefetch, prefetch, purge, put, putIfAbsent, remove, removeAllAtOnce, removeEntry, removeFromCyclicList, removeFromCyclicList, removeFromList, removeWithFlag, resetStorage, returnEntry, returnValue, setBulkCacheSource, setCacheConfig, setCacheManager, setEntryExpiryCalculator, setExceptionExpiryCalculator, setExperimentalBulkCacheSource, setExpirySeconds, setFeatureBit, setName, setRefreshController, setSource, setSource, stopStartTimer, timerEvent, toString, updateShutdownWaitFuture

Methods inherited from class java.lang.Object

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

Constructor Detail

ClockCache

public ClockCache()

Method Detail

getHitCnt

public long getHitCnt()

Specified by:

getHitCnt in class BaseCache<org.cache2k.impl.ClockCache.Entry,K,T>

initializeHeapCache

protected void initializeHeapCache()

Overrides:

initializeHeapCache in class BaseCache<org.cache2k.impl.ClockCache.Entry,K,T>

removeEntryFromReplacementList

protected void removeEntryFromReplacementList(org.cache2k.impl.ClockCache.Entry e)

Overrides:

removeEntryFromReplacementList in class BaseCache<org.cache2k.impl.ClockCache.Entry,K,T>

recordHit

protected void recordHit(org.cache2k.impl.ClockCache.Entry e)

Description copied from class: BaseCache

Record an entry hit.

Specified by:

recordHit in class BaseCache<org.cache2k.impl.ClockCache.Entry,K,T>

insertIntoReplacementList

protected void insertIntoReplacementList(org.cache2k.impl.ClockCache.Entry e)

Description copied from class: BaseCache

New cache entry, put it in the replacement algorithm structure

Specified by:

insertIntoReplacementList in class BaseCache<org.cache2k.impl.ClockCache.Entry,K,T>

newEntry

protected org.cache2k.impl.ClockCache.Entry newEntry()

Description copied from class: BaseCache

Entry object factory. Return an entry of the proper entry subtype for the replacement/eviction algorithm.

Specified by:

newEntry in class BaseCache<org.cache2k.impl.ClockCache.Entry,K,T>

findEvictionCandidate

protected org.cache2k.impl.ClockCache.Entry findEvictionCandidate()

Run to evict an entry.

Overrides:

findEvictionCandidate in class BaseCache<org.cache2k.impl.ClockCache.Entry,K,T>

getIntegrityState

protected IntegrityState getIntegrityState()

Overrides:

getIntegrityState in class BaseCache<org.cache2k.impl.ClockCache.Entry,K,T>

getExtraStatistics

protected String getExtraStatistics()

Overrides:

getExtraStatistics in class BaseCache<org.cache2k.impl.ClockCache.Entry,K,T>