org.gridgain.grid.kernal.processors.cache.distributed.near

Class GridNearCacheEntry<K,V>

java.lang.Object

org.gridgain.grid.kernal.processors.cache.GridCacheMapEntry<K,V>

org.gridgain.grid.kernal.processors.cache.distributed.GridDistributedCacheEntry<K,V>

org.gridgain.grid.kernal.processors.cache.distributed.near.GridNearCacheEntry<K,V>

All Implemented Interfaces:

Serializable, GridMetadataAware, GridCacheEntryEx<K,V>

public class GridNearCacheEntry<K,V>
extends GridDistributedCacheEntry<K,V>

Near cache entry.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.gridgain.grid.kernal.processors.cache.GridCacheMapEntry

cctx, flags, key, log, logRef, startVer, val, valBytes, ver

Constructor Summary

Constructors

Constructor and Description
GridNearCacheEntry(GridCacheContext<K,V> ctx, K key, int hash, V val, GridCacheMapEntry<K,V> next, long ttl, int hdrId)

Method Summary

Methods

Modifier and Type	Method and Description
GridCacheMvccCandidate<K>	addLocal(long threadId, GridCacheVersion ver, long timeout, boolean reenter, boolean tx, boolean implicitSingle) Add local candidate.
GridCacheMvccCandidate<K>	addNearLocal(UUID dhtNodeId, long threadId, GridCacheVersion ver, long timeout, boolean reenter, boolean tx, boolean implicitSingle) Add near local candidate.
protected void	clearIndex(V val) Clears index.
GridCacheMvccCandidate<K>	dhtNodeId(GridCacheVersion ver, UUID dhtNodeId)
GridCacheVersion	dhtVersion()
boolean	initializeFromDht(long topVer)
boolean	isNear()
boolean	loadedValue(GridCacheTxEx tx, UUID primaryNodeId, V val, byte[] valBytes, GridCacheVersion ver, GridCacheVersion dhtVer, GridCacheVersion expVer, long ttl, long expireTime, boolean evt, long topVer, UUID subjId)
int	memorySize()
protected void	onInvalidate() Called when entry invalidated.
int	partition()
protected V	readThrough(GridCacheTxEx<K,V> tx, K key, boolean reload, GridPredicate<GridCacheEntry<K,V>>[] filter, UUID subjId)
GridCacheMvccCandidate<K>	readyLock(GridCacheMvccCandidate<K> cand)
void	recordDhtVersion(GridCacheVersion dhtVer) This method should be called only when committing optimistic transactions.
protected void	recordNodeId(UUID primaryNodeId)
protected void	refreshAhead(K key, GridCacheVersion matchVer)
GridCacheMvccCandidate<K>	removeLock() Unlocks local lock.
boolean	resetFromPrimary(V val, byte[] valBytes, GridCacheVersion ver, GridCacheVersion dhtVer, UUID primaryNodeId) This method should be called only when lock is owned on this entry.
String	toString()
protected void	updateIndex(V val, byte[] valBytes, long expireTime, GridCacheVersion ver, V old) Updates cache index.
void	updateOrEvict(GridCacheVersion dhtVer, V val, byte[] valBytes, long expireTime, long ttl, UUID primaryNodeId) This method should be called only when lock is owned on this entry.
boolean	valid(long topVer)
GridTuple3<GridCacheVersion,V,byte[]>	versionedValue()
GridCacheEntry<K,V>	wrap(boolean prjAware) Wraps this map entry into cache entry.

Methods inherited from class org.gridgain.grid.kernal.processors.cache.distributed.GridDistributedCacheEntry

addRemote, addRemote, addRemoteCandidates, addRemoved, checkCallbacks, checkOwnerChanged, checkRemoved, checkThreadChain, doneRemote, doneRemote, orderCompleted, readyLock, readyNearLock, recheck, refreshRemotes, remoteMvccSnapshot, removeExplicitNodeLocks, removeLock, tmLock, txUnlock

Methods inherited from class org.gridgain.grid.kernal.processors.cache.GridCacheMapEntry

addMeta, addMetaIfAbsent, addMetaIfAbsent, allMeta, candidate, candidate, checkObsolete, clear, clearReaders, compact, context, copyMeta, copyMeta, createValueBytes, deleted, deletedUnlocked, deletedUnlocked, detached, drEntry, equals, evictInBatchInternal, evictInternal, evictWrap, expireTime, expireTimeExtras, expireTimeUnlocked, getOrMarshalKeyBytes, hashCode, hasLockCandidate, hasLockCandidate, hasLockCandidateUnsafe, hasMeta, hasMeta, hasReaders, hasValue, hasValueUnlocked, info, initialValue, initialValue, innerGet, innerReload, innerRemove, innerSet, innerUpdate, innerUpdateLocal, invalidate, invalidate, isDht, isInternal, isLocal, isNew, isNewLocked, isOffHeapValuesOnly, isReplicated, isStartVersion, isStoreValueBytes, key, keyBytes, keyBytes, localCandidate, localCandidates, localOwner, lockedBy, lockedByAny, lockedByThread, lockedByThread, lockedByThread, lockedByThreadUnsafe, lockedByUnsafe, lockedLocally, lockedLocallyByIdOrThread, lockedLocallyUnsafe, markObsolete, markObsolete0, markObsoleteIfEmpty, markObsoleteVersion, meta, mvccExtras, mvccExtras, obsolete, obsolete, obsoleteOrDeleted, obsoleteVersion, obsoleteVersionExtras, obsoleteVersionExtras, onMarkedObsolete, onTtlExpired, partitionValid, peek, peek, peek0, peekFailFast, poke, putMetaIfAbsent, putMetaIfAbsent, rawExpireTime, rawGet, rawGetOrUnmarshal, rawGetOrUnmarshalUnlocked, rawPut, rawTtl, readExternalMeta, refreshingLocked, refreshingUnlocked, releaseSwap, removeMeta, removeMeta, replaceMeta, saveValueForIndexUnlocked, startVersion, toExpireTime, ttl, ttlAndExpireTimeExtras, ttlExtras, unswap, unswap, update, value, valueBytes, valueBytes, valueBytesUnlocked, version, versionedValue, visitable, wrapFilterLocked, writeExternalMeta

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GridNearCacheEntry

public GridNearCacheEntry(GridCacheContext<K,V> ctx,
                  K key,
                  int hash,
                  V val,
                  GridCacheMapEntry<K,V> next,
                  long ttl,
                  int hdrId)

Parameters:

ctx - Cache context.

key - Cache key.

hash - Key hash value.

val - Entry value.

next - Next entry in the linked list.

ttl - Time to live.

hdrId - Header id.

Method Detail

memorySize

public int memorySize()
               throws GridException

Specified by:

memorySize in interface GridCacheEntryEx<K,V>

Overrides:

memorySize in class GridCacheMapEntry<K,V>

Returns:

Memory size.

Throws:

GridException - If failed.

partition

public int partition()

Specified by:

partition in interface GridCacheEntryEx<K,V>

Overrides:

partition in class GridCacheMapEntry<K,V>

Returns:

Partition ID.

isNear

public boolean isNear()

Specified by:

isNear in interface GridCacheEntryEx<K,V>

Overrides:

isNear in class GridCacheMapEntry<K,V>

Returns:

True if near.

valid

public boolean valid(long topVer)

Specified by:

valid in interface GridCacheEntryEx<K,V>

Overrides:

valid in class GridCacheMapEntry<K,V>

Parameters:

topVer - Topology version where validation should be performed. When negative the latest available topology should be used.

Returns:

Checks if value is valid.

initializeFromDht

public boolean initializeFromDht(long topVer)
                          throws GridCacheEntryRemovedException

Parameters:

topVer - Topology version.

Returns:

True if this entry was initialized by this call.

Throws:

GridCacheEntryRemovedException - If this entry is obsolete.

resetFromPrimary

public boolean resetFromPrimary(V val,
                       byte[] valBytes,
                       GridCacheVersion ver,
                       GridCacheVersion dhtVer,
                       UUID primaryNodeId)
                         throws GridCacheEntryRemovedException,
                                GridException

This method should be called only when lock is owned on this entry.

Parameters:

val - Value.

valBytes - Value bytes.

ver - Version.

dhtVer - DHT version.

primaryNodeId - Primary node ID.

Returns:

True if reset was done.

Throws:

GridCacheEntryRemovedException - If obsolete.

GridException - If failed.

updateOrEvict

public void updateOrEvict(GridCacheVersion dhtVer,
                 @Nullable
                 V val,
                 @Nullable
                 byte[] valBytes,
                 long expireTime,
                 long ttl,
                 UUID primaryNodeId)

This method should be called only when lock is owned on this entry.

Parameters:

dhtVer - DHT version.

val - Value associated with version.

valBytes - Value bytes.

expireTime - Expire time.

ttl - Time to live.

primaryNodeId - Primary node ID.

dhtVersion

@Nullable
public GridCacheVersion dhtVersion()
                            throws GridCacheEntryRemovedException

Returns:

DHT version for this entry.

Throws:

GridCacheEntryRemovedException - If obsolete.

versionedValue

@Nullable
public GridTuple3<GridCacheVersion,V,byte[]> versionedValue()
                                                     throws GridCacheEntryRemovedException

Returns:

Tuple with version and value of this entry.

Throws:

GridCacheEntryRemovedException - If entry has been removed.

recordNodeId

protected void recordNodeId(UUID primaryNodeId)

Overrides:

recordNodeId in class GridCacheMapEntry<K,V>

Parameters:

primaryNodeId - Node ID.

recordDhtVersion

public void recordDhtVersion(GridCacheVersion dhtVer)

This method should be called only when committing optimistic transactions.

Parameters:

dhtVer - DHT version to record.

refreshAhead

protected void refreshAhead(K key,
                GridCacheVersion matchVer)

Overrides:

refreshAhead in class GridCacheMapEntry<K,V>

Parameters:

key - Key.

matchVer - Version to match.

readThrough

protected V readThrough(GridCacheTxEx<K,V> tx,
            K key,
            boolean reload,
            GridPredicate<GridCacheEntry<K,V>>[] filter,
            UUID subjId)
                 throws GridException

Overrides:

readThrough in class GridCacheMapEntry<K,V>

Parameters:

tx - Transaction.

key - Key.

reload - flag.

filter - Filter.

Returns:

Read value.

Throws:

GridException - If failed.

loadedValue

public boolean loadedValue(@Nullable
                  GridCacheTxEx tx,
                  UUID primaryNodeId,
                  V val,
                  byte[] valBytes,
                  GridCacheVersion ver,
                  GridCacheVersion dhtVer,
                  @Nullable
                  GridCacheVersion expVer,
                  long ttl,
                  long expireTime,
                  boolean evt,
                  long topVer,
                  UUID subjId)
                    throws GridException,
                           GridCacheEntryRemovedException

Parameters:

tx - Transaction.

primaryNodeId - Primary node ID.

val - New value.

valBytes - Value bytes.

ver - Version to use.

dhtVer - DHT version received from remote node.

expVer - Optional version to match.

ttl - Time to live.

expireTime - Expiration time.

evt - Event flag.

topVer - Topology version.

Returns:

True if initial value was set.

Throws:

GridException - In case of error.

GridCacheEntryRemovedException - If entry was removed.

updateIndex

protected void updateIndex(V val,
               byte[] valBytes,
               long expireTime,
               GridCacheVersion ver,
               V old)
                    throws GridException

Updates cache index.

Overrides:

updateIndex in class GridCacheMapEntry<K,V>

Parameters:

val - Value.

valBytes - Value bytes.

expireTime - Expire time.

ver - New entry version.

old - Previous value.

Throws:

GridException - If update failed.

clearIndex

protected void clearIndex(V val)

Clears index.

Overrides:

clearIndex in class GridCacheMapEntry<K,V>

Parameters:

val - Previous value (if needed for index update).

addLocal

public GridCacheMvccCandidate<K> addLocal(long threadId,
                                 GridCacheVersion ver,
                                 long timeout,
                                 boolean reenter,
                                 boolean tx,
                                 boolean implicitSingle)
                                   throws GridCacheEntryRemovedException

Add local candidate.

Overrides:

addLocal in class GridDistributedCacheEntry<K,V>

Parameters:

threadId - Owning thread ID.

ver - Lock version.

timeout - Timeout to acquire lock.

reenter - Reentry flag.

tx - Transaction flag.

implicitSingle - Implicit flag.

Returns:

New candidate.

Throws:

GridCacheEntryRemovedException - If entry has been removed.

addNearLocal

@Nullable
public GridCacheMvccCandidate<K> addNearLocal(@Nullable
                                              UUID dhtNodeId,
                                              long threadId,
                                              GridCacheVersion ver,
                                              long timeout,
                                              boolean reenter,
                                              boolean tx,
                                              boolean implicitSingle)
                                       throws GridCacheEntryRemovedException

Add near local candidate.

Parameters:

dhtNodeId - DHT node ID.

threadId - Owning thread ID.

ver - Lock version.

timeout - Timeout to acquire lock.

reenter - Reentry flag.

tx - Transaction flag.

implicitSingle - Implicit flag.

Returns:

New candidate.

Throws:

GridCacheEntryRemovedException - If entry has been removed.

dhtNodeId

@Nullable
public GridCacheMvccCandidate<K> dhtNodeId(GridCacheVersion ver,
                                           UUID dhtNodeId)
                                    throws GridCacheEntryRemovedException

Parameters:

ver - Version to set DHT node ID for.

dhtNodeId - DHT node ID.

Returns:

true if candidate was found.

Throws:

GridCacheEntryRemovedException - If entry is removed.

readyLock

public GridCacheMvccCandidate<K> readyLock(GridCacheMvccCandidate<K> cand)
                                    throws GridCacheEntryRemovedException

Overrides:

readyLock in class GridDistributedCacheEntry<K,V>

Parameters:

cand - Candidate to acquire lock for.

Returns:

Owner.

Throws:

GridCacheEntryRemovedException - If entry is removed.

removeLock

@Nullable
public GridCacheMvccCandidate<K> removeLock()

Unlocks local lock.

Overrides:

removeLock in class GridDistributedCacheEntry<K,V>

Returns:

Removed candidate, or null if thread still holds the lock.

onInvalidate

protected void onInvalidate()

Called when entry invalidated.

Overrides:

onInvalidate in class GridCacheMapEntry<K,V>

wrap

public GridCacheEntry<K,V> wrap(boolean prjAware)

Wraps this map entry into cache entry.

Specified by:

wrap in interface GridCacheEntryEx<K,V>

Overrides:

wrap in class GridCacheMapEntry<K,V>

Parameters:

prjAware - true if entry should inherit projection properties.

Returns:

Wrapped entry.

toString

public String toString()

Overrides:

toString in class GridDistributedCacheEntry<K,V>