com.hazelcast.internal.nearcache.impl.store

Class BaseHeapNearCacheRecordStore<K,V,R extends NearCacheRecord>

java.lang.Object

com.hazelcast.internal.nearcache.impl.store.AbstractNearCacheRecordStore<K,V,K,R,HeapNearCacheRecordMap<K,R>>

com.hazelcast.internal.nearcache.impl.store.BaseHeapNearCacheRecordStore<K,V,R>

Type Parameters:

K - the type of the key stored in Near Cache

V - the type of the value stored in Near Cache

R - the type of the value of the underlying NearCacheRecordMap

All Implemented Interfaces:

EvictionListener<K,R>, NearCacheRecordStore<K,V>, InitializingObject

Direct Known Subclasses:

NearCacheDataRecordStore, NearCacheObjectRecordStore

public abstract class BaseHeapNearCacheRecordStore<K,V,R extends NearCacheRecord>
extends AbstractNearCacheRecordStore<K,V,K,R,HeapNearCacheRecordMap<K,R>>

Base implementation of AbstractNearCacheRecordStore for on-heap Near Caches.

Nested Class Summary

Nested classes/interfaces inherited from class com.hazelcast.internal.nearcache.impl.store.AbstractNearCacheRecordStore

AbstractNearCacheRecordStore.ReserveForUpdateFunction

Field Summary

Fields inherited from class com.hazelcast.internal.nearcache.impl.store.AbstractNearCacheRecordStore

classLoader, evictionChecker, evictionDisabled, evictionPolicyEvaluator, evictionStrategy, inMemoryFormat, maxIdleMillis, MILLI_SECONDS_IN_A_SECOND, nearCacheConfig, nearCacheStats, records, REFERENCE_SIZE, RESERVATION_ID, reservationId, serializationService, staleReadDetector, timeToLiveMillis

Fields inherited from interface com.hazelcast.internal.eviction.EvictionListener

NO_LISTENER

Method Summary

Modifier and Type	Method and Description
protected boolean	containsRecordKey(K key)
protected EvictionChecker	createNearCacheEvictionChecker(EvictionConfig evictionConfig, NearCacheConfig nearCacheConfig)
protected HeapNearCacheRecordMap<K,R>	createNearCacheRecordMap(NearCacheConfig nearCacheConfig)
void	destroy() Clears the record store and destroys it.
void	doExpiration() Performs expiration and evicts expired records.
protected R	getOrCreateToReserve(K key, Data keyData)
R	getRecord(K key) Gets the record associated with the given key.
void	invalidate(K key) Removes the value associated with the given key and increases the invalidation statistics.
void	loadKeys(DataStructureAdapter<Object,?> adapter) Loads the keys into the Near Cache.
void	onEvict(K key, R record, boolean wasExpired) Called when an Evictable entry is evicted.
protected R	putRecord(K key, R record)
void	storeKeys() Persists the key set of the Near Cache.
protected V	updateAndGetReserved(K key, V value, long reservationId, boolean deserialize)

Methods inherited from class com.hazelcast.internal.nearcache.impl.store.AbstractNearCacheRecordStore

canUpdateStats, checkAvailable, clear, createRecord, doEviction, get, getKeyStorageMemoryCost, getNearCacheStats, getRecordStorageMemoryCost, getStaleReadDetector, getTotalStorageMemoryCost, initialize, isRecordExpired, onExpire, onGet, onGetError, onPut, onPutError, onRecordCreate, onRemove, onRemoveError, put, recordToValue, setStaleReadDetector, size, toData, toValue, tryPublishReserved, tryReserveForUpdate, updateRecordValue, updateReservedRecordInternal

Methods inherited from class java.lang.Object

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

Method Detail

createNearCacheEvictionChecker

protected EvictionChecker createNearCacheEvictionChecker(EvictionConfig evictionConfig,
                                                         NearCacheConfig nearCacheConfig)

Specified by:

createNearCacheEvictionChecker in class AbstractNearCacheRecordStore<K,V,K,R extends NearCacheRecord,HeapNearCacheRecordMap<K,R extends NearCacheRecord>>

createNearCacheRecordMap

protected HeapNearCacheRecordMap<K,R> createNearCacheRecordMap(NearCacheConfig nearCacheConfig)

Specified by:

createNearCacheRecordMap in class AbstractNearCacheRecordStore<K,V,K,R extends NearCacheRecord,HeapNearCacheRecordMap<K,R extends NearCacheRecord>>

getRecord

public R getRecord(K key)

Description copied from interface: NearCacheRecordStore

Gets the record associated with the given key.

Specified by:

getRecord in interface NearCacheRecordStore<K,V>

Specified by:

getRecord in class AbstractNearCacheRecordStore<K,V,K,R extends NearCacheRecord,HeapNearCacheRecordMap<K,R extends NearCacheRecord>>

Parameters:

key - the key from which to get the associated NearCacheRecord.

Returns:

the NearCacheRecord associated with the given key.

putRecord

protected R putRecord(K key,
                      R record)

Specified by:

putRecord in class AbstractNearCacheRecordStore<K,V,K,R extends NearCacheRecord,HeapNearCacheRecordMap<K,R extends NearCacheRecord>>

containsRecordKey

protected boolean containsRecordKey(K key)

Specified by:

containsRecordKey in class AbstractNearCacheRecordStore<K,V,K,R extends NearCacheRecord,HeapNearCacheRecordMap<K,R extends NearCacheRecord>>

onEvict

public void onEvict(K key,
                    R record,
                    boolean wasExpired)

Description copied from interface: EvictionListener

Called when an Evictable entry is evicted.

Specified by:

onEvict in interface EvictionListener<K,R extends NearCacheRecord>

Overrides:

onEvict in class AbstractNearCacheRecordStore<K,V,K,R extends NearCacheRecord,HeapNearCacheRecordMap<K,R extends NearCacheRecord>>

Parameters:

key - Accessor of the Evictable entry that is evicted.

record - Evictable entry that is evicted.

wasExpired - true if the entry was evicted due to expiration, false otherwise

doExpiration

public void doExpiration()

Description copied from interface: NearCacheRecordStore

Performs expiration and evicts expired records.

loadKeys

public void loadKeys(DataStructureAdapter<Object,?> adapter)

Description copied from interface: NearCacheRecordStore

Loads the keys into the Near Cache.

storeKeys

public void storeKeys()

Description copied from interface: NearCacheRecordStore

Persists the key set of the Near Cache.

destroy

public void destroy()

Description copied from interface: NearCacheRecordStore

Clears the record store and destroys it.

Specified by:

destroy in interface NearCacheRecordStore<K,V>

Overrides:

destroy in class AbstractNearCacheRecordStore<K,V,K,R extends NearCacheRecord,HeapNearCacheRecordMap<K,R extends NearCacheRecord>>

getOrCreateToReserve

protected R getOrCreateToReserve(K key,
                                 Data keyData)

Specified by:

getOrCreateToReserve in class AbstractNearCacheRecordStore<K,V,K,R extends NearCacheRecord,HeapNearCacheRecordMap<K,R extends NearCacheRecord>>

updateAndGetReserved

protected V updateAndGetReserved(K key,
                                 V value,
                                 long reservationId,
                                 boolean deserialize)

Specified by:

updateAndGetReserved in class AbstractNearCacheRecordStore<K,V,K,R extends NearCacheRecord,HeapNearCacheRecordMap<K,R extends NearCacheRecord>>

invalidate

public void invalidate(K key)

Description copied from interface: NearCacheRecordStore

Removes the value associated with the given key and increases the invalidation statistics.

Parameters:

key - the key of the value will be invalidated