com.hazelcast.internal.nearcache

Interface NearCacheRecordStore<K,V>

Type Parameters:

K - the type of the key

V - the type of the value

All Superinterfaces:

InitializingObject

All Known Implementing Classes:

AbstractNearCacheRecordStore, BaseHeapNearCacheRecordStore, NearCacheDataRecordStore, NearCacheObjectRecordStore

public interface NearCacheRecordStore<K,V>
extends InitializingObject

NearCacheRecordStore is the contract point to store keys and values as NearCacheRecord internally and to serve them.

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all stored values.
void	destroy() Clears the record store and destroys it.
void	doEviction(boolean withoutMaxSizeCheck) Does eviction as specified configuration EvictionConfig in NearCacheConfig.
void	doExpiration() Performs expiration and evicts expired records.
V	get(K key) Gets the value associated with the given key.
NearCacheStats	getNearCacheStats() Get the NearCacheStats instance to monitor this record store.
NearCacheRecord	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	put(K key, Data keyData, V value, Data valueData) Puts (associates) a value with the given key.
void	setStaleReadDetector(StaleReadDetector detector)
int	size() Gets the number of stored records.
void	storeKeys() Persists the key set of the Near Cache.
V	tryPublishReserved(K key, V value, long reservationId, boolean deserialize) Tries to update reserved key with supplied value.
long	tryReserveForUpdate(K key, Data keyData) Tries to reserve supplied key for update.

Methods inherited from interface com.hazelcast.spi.InitializingObject

initialize

Method Detail

get

V get(K key)

Gets the value associated with the given key.

Parameters:

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

Returns:

the value associated with the given key.

put

void put(K key,
         Data keyData,
         V value,
         Data valueData)

Puts (associates) a value with the given key.

Parameters:

key - the key to which the given value will be associated.

keyData - the key as Data to which the given value will be associated.

value - the value that will be associated with the key.

valueData -

tryReserveForUpdate

long tryReserveForUpdate(K key,
                         Data keyData)

Tries to reserve supplied key for update.

If one thread takes reservation, only that thread can update the key.

Parameters:

key - key to be reserved for update

keyData - key to be reserved for update as Data

Returns:

reservation ID if reservation succeeds, else returns NearCacheRecord.NOT_RESERVED

tryPublishReserved

V tryPublishReserved(K key,
                     V value,
                     long reservationId,
                     boolean deserialize)

Tries to update reserved key with supplied value. If update happens, value is published. Publishing means making the value readable to all threads. If update fails, record is not updated.

Parameters:

key - reserved key for update

value - value to be associated with reserved key

reservationId - ID for this reservation

deserialize - eagerly deserialize returning value

Returns:

associated value if deserialize is true and update succeeds, otherwise returns null

invalidate

void invalidate(K key)

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

Parameters:

key - the key of the value will be invalidated

clear

void clear()

Removes all stored values.

destroy

void destroy()

Clears the record store and destroys it.

size

int size()

Gets the number of stored records.

Returns:

the number of stored records.

getRecord

NearCacheRecord getRecord(K key)

Gets the record associated with the given key.

Parameters:

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

Returns:

the NearCacheRecord associated with the given key.

getNearCacheStats

NearCacheStats getNearCacheStats()

Get the NearCacheStats instance to monitor this record store.

Returns:

the NearCacheStats instance to monitor this record store.

doExpiration

void doExpiration()

Performs expiration and evicts expired records.

doEviction

void doEviction(boolean withoutMaxSizeCheck)

Does eviction as specified configuration EvictionConfig in NearCacheConfig.

Parameters:

withoutMaxSizeCheck - set true to evict regardless of a max size check, otherwise set false to evict after a max size check.

loadKeys

void loadKeys(DataStructureAdapter<Object,?> adapter)

Loads the keys into the Near Cache.

storeKeys

void storeKeys()

Persists the key set of the Near Cache.

setStaleReadDetector

void setStaleReadDetector(StaleReadDetector detector)

See Also:

StaleReadDetector