Apache::Geode::Client::RegionEntry< TKey, TValue > Class Template Reference

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

#include <RegionEntry.hpp>

Properties
bool	IsDestroyed [get]
	True if this entry has been destroyed.
TKey	Key [get]
	Returns the key for this entry.
IRegion< TKey, TValue >^	Region [get]
	Returns the region that contains this entry.
Apache::Geode::Client::CacheStatistics^	Statistics [get]
	Returns the statistics for this entry.
TValue	Value [get]
	Returns the value of this entry in the local cache.

Detailed Description

template<class TKey, class TValue>
class Apache::Geode::Client::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.

Property Documentation

IsDestroyed

template<class TKey , class TValue >

bool Apache::Geode::Client::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

Key

template<class TKey , class TValue >

TKey Apache::Geode::Client::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

Region

template<class TKey , class TValue >

IRegion< TKey, TValue>^ Apache::Geode::Client::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

Statistics

template<class TKey , class TValue >

Apache:: Geode:: Client:: CacheStatistics^ Apache::Geode::Client::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

Value

template<class TKey , class TValue >

TValue Apache::Geode::Client::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