GemStone::GemFire::Cache::Generic::RegionEntry< TKey, TValue > Class Template Reference

Inherits GemStone::GemFire::Cache::Generic::Internal::SBWrap< gemfire::RegionEntry >.


Detailed Description

template<class TKey, class TValue>
class GemStone::GemFire::Cache::Generic::RegionEntry< TKey, TValue >

An object in a region that represents an entry, that is, a key-value pair.

This object's operations are not distributed, do not acquire any locks, and do not affect CacheStatistics.

Unless otherwise noted, all of these methods throw a CacheClosedException if the cache is closed at the time of invocation, or an EntryDestroyedException if the entry has been destroyed.

Call IsDestroyed to see if an entry has already been destroyed.

Protected Member Functions

void _SetNativePtr (gemfire::RegionEntry *nativeptr)
void AssignPtr (gemfire::RegionEntry *nativeptr)
void InternalCleanup ()
void SetPtr (gemfire::RegionEntry *nativeptr)

Properties

bool IsDestroyed [get]
TKey Key [get]
IRegion< TKey, TValue >^ Region [get]
GemStone::GemFire::Cache::Generic::CacheStatistics^  Statistics [get]
TValue Value [get]


Member Function Documentation

void GemStone::GemFire::Cache::Generic::Internal::SBWrap< gemfire::RegionEntry >::_SetNativePtr ( gemfire::RegionEntry *  nativeptr  )  [inline, protected, inherited]

Set the native pointer to the new object without doing a preserveSB(). DO NOT USE UNLESS YOU KNOW WHAT YOU ARE DOING.

void GemStone::GemFire::Cache::Generic::Internal::SBWrap< gemfire::RegionEntry >::AssignPtr ( gemfire::RegionEntry *  nativeptr  )  [inline, protected, inherited]

Used to assign the native pointer to a new object.

Note the order of preserveSB() and releaseSB(). This handles the corner case when m_nativeptr is same as nativeptr.

void GemStone::GemFire::Cache::Generic::Internal::SBWrap< gemfire::RegionEntry >::InternalCleanup (  )  [inline, protected, inherited]

Internal cleanup function invoked by dispose/finalizer.

void GemStone::GemFire::Cache::Generic::Internal::SBWrap< gemfire::RegionEntry >::SetPtr ( gemfire::RegionEntry *  nativeptr  )  [inline, protected, inherited]

Used to set the native pointer to a new object. This should only be used when you know that the underlying object is NULL.


Property Documentation

template<class TKey, class TValue>
bool GemStone::GemFire::Cache::Generic::RegionEntry< TKey, TValue >::IsDestroyed [get]

True if this entry has been destroyed.

Does not throw a EntryDestroyedException if this entry has been destroyed.

Returns:
true if this entry has been destroyed
Exceptions:
CacheClosedException if the cache is closed at the time of invocation

template<class TKey, class TValue>
TKey GemStone::GemFire::Cache::Generic::RegionEntry< TKey, TValue >::Key [get]

Returns the key for this entry.

Returns:
the key for this entry
Exceptions:
CacheClosedException if the cache is closed at the time of invocation
EntryDestroyedException if the entry has been destroyed

template<class TKey, class TValue>
IRegion< TKey, TValue>^ GemStone::GemFire::Cache::Generic::RegionEntry< TKey, TValue >::Region [get]

Returns the region that contains this entry.

Returns:
the region that contains this entry
Exceptions:
CacheClosedException if the cache is closed at the time of invocation
EntryDestroyedException if the entry has been destroyed

template<class TKey, class TValue>
GemStone:: GemFire:: Cache:: Generic:: CacheStatistics^ GemStone::GemFire::Cache::Generic::RegionEntry< TKey, TValue >::Statistics [get]

Returns the statistics for this entry.

Returns:
the CacheStatistics for this entry
Exceptions:
StatisticsDisabledException if statistics have been disabled for this region

template<class TKey, class TValue>
TValue GemStone::GemFire::Cache::Generic::RegionEntry< TKey, TValue >::Value [get]

Returns the value of this entry in the local cache. Does not invoke an ICacheLoader, does not do a netSearch, netLoad, etc.

Returns:
the value, or null if this entry is invalid -- see IsDestroyed
Exceptions:
CacheClosedException if the cache is closed at the time of invocation
EntryDestroyedException if the entry has been destroyed


GemFire C++ Cache .NET API Documentation