org.apache.ignite.internal.processors.cache.distributed.dht

Class GridDhtCacheEntry<K,V>

java.lang.Object

org.apache.ignite.internal.processors.cache.GridCacheMapEntry<K,V>

org.apache.ignite.internal.processors.cache.distributed.GridDistributedCacheEntry<K,V>

org.apache.ignite.internal.processors.cache.distributed.dht.GridDhtCacheEntry<K,V>

All Implemented Interfaces:

GridCacheEntryEx<K,V>

Direct Known Subclasses:

GridDhtAtomicCacheEntry, GridDhtColocatedCacheEntry

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

Replicated cache entry.

Field Summary

Fields inherited from class org.apache.ignite.internal.processors.cache.GridCacheMapEntry

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

Constructor Summary

Constructors

Constructor and Description
GridDhtCacheEntry(GridCacheContext<K,V> ctx, long topVer, 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>	addDhtLocal(UUID nearNodeId, GridCacheVersion nearVer, long topVer, long threadId, GridCacheVersion ver, long timeout, boolean reenter, boolean tx, boolean implicitSingle) Add local candidate.
IgniteInternalFuture<Boolean>	addReader(UUID nodeId, long msgId, long topVer)
protected String	cacheName()
Collection<org.apache.ignite.internal.processors.cache.distributed.dht.GridDhtCacheEntry.ReaderId<K,V>>	checkReaders()
boolean	clearInternal(GridCacheVersion ver, boolean swap) Marks entry as obsolete and, if possible or required, removes it from swap storage.
void	clearReader(UUID nodeId)
void	clearReaders() Clears all readers (usually when partition becomes invalid and ready for eviction).
protected boolean	hasReaders()
boolean	isDht()
GridCacheMvccCandidate<K>	localCandidateByNearVersion(GridCacheVersion nearVer, boolean rmv)
GridCacheMvccCandidate<K>	mappings(GridCacheVersion ver) Sets mappings into entry.
int	memorySize()
void	onMarkedObsolete() This method should be called each time entry is marked obsolete other than by calling GridCacheEntryEx.markObsolete(GridCacheVersion).
void	onUnlock() Calls GridDhtLocalPartition.onUnlock() for this entry's partition.
int	partition()
boolean	partitionValid()
org.apache.ignite.internal.processors.cache.distributed.dht.GridDhtCacheEntry.ReaderId<K,V>	readerId(UUID nodeId)
Collection<UUID>	readers()
GridCacheMvccCandidate<K>	removeLock() Unlocks local lock.
boolean	removeLock(GridCacheVersion ver)
boolean	removeReader(UUID nodeId, long msgId)
boolean	tmLock(IgniteInternalTx<K,V> tx, long timeout) This locks is called by transaction manager during prepare step for optimistic transactions.
String	toString()
GridTuple3<GridCacheVersion,V,byte[]>	versionedValue(long topVer)

Methods inherited from class org.apache.ignite.internal.processors.cache.distributed.GridDistributedCacheEntry

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

Methods inherited from class org.apache.ignite.internal.processors.cache.GridCacheMapEntry

addMeta, candidate, candidate, checkObsolete, clear, clearIndex, compact, context, deleted, deletedUnlocked, deletedUnlocked, detached, equals, evictInBatchInternal, evictInternal, expireTime, expireTimeExtras, expireTimeUnlocked, getOrMarshalKeyBytes, hashCode, hasLockCandidate, hasLockCandidate, hasLockCandidateUnsafe, hasMeta, hasValue, hasValueUnlocked, info, initialValue, initialValue, innerGet, innerReload, innerRemove, innerSet, innerUpdate, innerUpdateLocal, invalidate, invalidate, isInternal, isLocal, isNear, 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, onInvalidate, onTtlExpired, peek, peek, peek, peek0, peekFailFast, poke, putMetaIfAbsent, putMetaIfAbsent, rawExpireTime, rawGet, rawGetOrUnmarshal, rawGetOrUnmarshalUnlocked, rawPut, rawTtl, readExternalMeta, readThrough, recordNodeId, releaseSwap, removeMeta, removeMeta, replaceMeta, saveValueForIndexUnlocked, startVersion, toExpireTime, ttl, ttlAndExpireTimeExtras, ttlExtras, txKey, unswap, unswap, update, updateIndex, updateTtl, valid, value, valueBytes, valueBytes, valueBytesUnlocked, version, versionedEntry, versionedValue, visitable, wrap, wrapEviction, wrapFilterLocked, wrapLazyValue, wrapVersioned, writeExternalMeta

Methods inherited from class java.lang.Object

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

Constructor Detail

GridDhtCacheEntry

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

Parameters:

ctx - Cache context.

topVer - Topology version at the time of creation (if negative, then latest topology is assumed).

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 IgniteCheckedException

Specified by:

memorySize in interface GridCacheEntryEx<K,V>

Overrides:

memorySize in class GridCacheMapEntry<K,V>

Returns:

Memory size.

Throws:

IgniteCheckedException - If failed.

partition

public int partition()

Specified by:

partition in interface GridCacheEntryEx<K,V>

Overrides:

partition in class GridCacheMapEntry<K,V>

Returns:

Partition ID.

isDht

public boolean isDht()

Specified by:

isDht in interface GridCacheEntryEx<K,V>

Overrides:

isDht in class GridCacheMapEntry<K,V>

Returns:

True if DHT.

partitionValid

public boolean partitionValid()

Specified by:

partitionValid in interface GridCacheEntryEx<K,V>

Overrides:

partitionValid in class GridCacheMapEntry<K,V>

Returns:

True if partition is in valid.

onMarkedObsolete

public void onMarkedObsolete()

This method should be called each time entry is marked obsolete other than by calling GridCacheEntryEx.markObsolete(GridCacheVersion).

Specified by:

onMarkedObsolete in interface GridCacheEntryEx<K,V>

Overrides:

onMarkedObsolete in class GridCacheMapEntry<K,V>

localCandidateByNearVersion

@Nullable
public GridCacheMvccCandidate<K> localCandidateByNearVersion(GridCacheVersion nearVer,
                                                             boolean rmv)
                                                      throws GridCacheEntryRemovedException

Parameters:

nearVer - Near version.

rmv - If true, then add to removed list if not found.

Returns:

Local candidate by near version.

Throws:

GridCacheEntryRemovedException - If removed.

addDhtLocal

@Nullable
public GridCacheMvccCandidate<K> addDhtLocal(UUID nearNodeId,
                                             GridCacheVersion nearVer,
                                             long topVer,
                                             long threadId,
                                             GridCacheVersion ver,
                                             long timeout,
                                             boolean reenter,
                                             boolean tx,
                                             boolean implicitSingle)
                                      throws GridCacheEntryRemovedException,
                                             GridDistributedLockCancelledException

Add local candidate.

Parameters:

nearNodeId - Near node ID.

nearVer - Near version.

topVer - Topology version.

threadId - Owning thread ID.

ver - Lock version.

timeout - Timeout to acquire lock.

reenter - Reentry flag.

tx - Tx flag.

implicitSingle - Implicit flag.

Returns:

New candidate.

Throws:

GridCacheEntryRemovedException - If entry has been removed.

GridDistributedLockCancelledException - If lock was cancelled.

tmLock

public boolean tmLock(IgniteInternalTx<K,V> tx,
             long timeout)
               throws GridCacheEntryRemovedException,
                      GridDistributedLockCancelledException

This locks is called by transaction manager during prepare step for optimistic transactions.

Specified by:

tmLock in interface GridCacheEntryEx<K,V>

Overrides:

tmLock in class GridDistributedCacheEntry<K,V>

Parameters:

tx - Cache transaction.

timeout - Timeout for lock acquisition.

Returns:

True if lock was acquired, false otherwise.

Throws:

GridCacheEntryRemovedException - If this entry is obsolete.

GridDistributedLockCancelledException - If lock has been cancelled.

removeLock

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.

removeLock

public boolean removeLock(GridCacheVersion ver)
                   throws GridCacheEntryRemovedException

Specified by:

removeLock in interface GridCacheEntryEx<K,V>

Overrides:

removeLock in class GridDistributedCacheEntry<K,V>

Parameters:

ver - Removes lock.

Returns:

True If lock has been removed.

Throws:

GridCacheEntryRemovedException - If this entry has been removed from cache.

onUnlock

public void onUnlock()

Calls GridDhtLocalPartition.onUnlock() for this entry's partition.

versionedValue

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

Parameters:

topVer - Topology version.

Returns:

Tuple with version and value of this entry, or null if entry is new.

Throws:

GridCacheEntryRemovedException - If entry has been removed.

readers

public Collection<UUID> readers()
                         throws GridCacheEntryRemovedException

Returns:

Readers.

Throws:

GridCacheEntryRemovedException - If removed.

readerId

@Nullable
public org.apache.ignite.internal.processors.cache.distributed.dht.GridDhtCacheEntry.ReaderId<K,V> readerId(UUID nodeId)

Parameters:

nodeId - Node ID.

Returns:

reader ID.

addReader

@Nullable
public IgniteInternalFuture<Boolean> addReader(UUID nodeId,
                                               long msgId,
                                               long topVer)
                                        throws GridCacheEntryRemovedException

Parameters:

nodeId - Reader to add.

msgId - Message ID.

topVer - Topology version.

Returns:

Future for all relevant transactions that were active at the time of adding reader, or null if reader was added

Throws:

GridCacheEntryRemovedException - If entry was removed.

removeReader

public boolean removeReader(UUID nodeId,
                   long msgId)
                     throws GridCacheEntryRemovedException

Parameters:

nodeId - Reader to remove.

msgId - Message ID.

Returns:

True if reader was removed as a result of this operation.

Throws:

GridCacheEntryRemovedException - If entry was removed.

clearReaders

public void clearReaders()

Clears all readers (usually when partition becomes invalid and ready for eviction).

Overrides:

clearReaders in class GridCacheMapEntry<K,V>

clearReader

public void clearReader(UUID nodeId)
                 throws GridCacheEntryRemovedException

Overrides:

clearReader in class GridCacheMapEntry<K,V>

Parameters:

nodeId - Node ID to clear.

Throws:

GridCacheEntryRemovedException

clearInternal

public boolean clearInternal(GridCacheVersion ver,
                    boolean swap)
                      throws IgniteCheckedException

Marks entry as obsolete and, if possible or required, removes it from swap storage.

Parameters:

ver - Obsolete version.

swap - If true then remove from swap.

Returns:

True if entry was not being used, passed the filter and could be removed.

Throws:

IgniteCheckedException - If failed to remove from swap.

checkReaders

public Collection<org.apache.ignite.internal.processors.cache.distributed.dht.GridDhtCacheEntry.ReaderId<K,V>> checkReaders()
                                                                                                                     throws GridCacheEntryRemovedException

Returns:

Collection of readers after check.

Throws:

GridCacheEntryRemovedException - If removed.

hasReaders

protected boolean hasReaders()
                      throws GridCacheEntryRemovedException

Overrides:

hasReaders in class GridCacheMapEntry<K,V>

Returns:

true if entry has readers. It makes sense only for dht entry.

Throws:

GridCacheEntryRemovedException - If removed.

mappings

@Nullable
public GridCacheMvccCandidate<K> mappings(GridCacheVersion ver)
                                   throws GridCacheEntryRemovedException

Sets mappings into entry.

Parameters:

ver - Version.

Returns:

Candidate, if one existed for the version, or null if candidate was not found.

Throws:

GridCacheEntryRemovedException - If removed.

cacheName

protected String cacheName()

Returns:

Cache name.

toString

public String toString()

Overrides:

toString in class GridDistributedCacheEntry<K,V>