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

Inherits GemStone::GemFire::Cache::Generic::Internal::SBWrap< gemfire::RegionAttributes >, and GemStone::GemFire::Cache::Generic::IGFSerializable.

---

Detailed Description

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

Defines attributes for configuring a region.

These are ICacheListener, ICacheLoader, ICacheWriter, scope, mirroring, and expiration attributes for the region itself; expiration attributes for the region entries; and whether statistics are enabled for the region and its entries.

To create an instance of this interface, use AttributesFactory.CreateRegionAttributes.

For compatibility rules and default values, see AttributesFactory.

Note that the RegionAttributes are not distributed with the region.

See also:

AttributesFactory, AttributesMutator, Region.Attributes

Public Member Functions
virtual bool	Equals (Object^ other) override
bool	Equals (RegionAttributes< TKey, TValue >^other)
virtual IGFSerializable^	FromData (DataInput^ input)
virtual void	ToData (DataOutput^ output)
String^	ToString ()
void	ValidateSerializableAttributes ()
Protected Member Functions
void	_SetNativePtr (gemfire::RegionAttributes *nativeptr)
void	AssignPtr (gemfire::RegionAttributes *nativeptr)
void	InternalCleanup ()
void	SetPtr (gemfire::RegionAttributes *nativeptr)
Properties
ICacheListener< TKey, TValue >^	CacheListener [get]
String^	CacheListenerFactory [get]
String^	CacheListenerLibrary [get]
GemStone::GemFire::Cache::Generic::ICacheLoader < TKey, TValue >^	CacheLoader [get]
String^	CacheLoaderFactory [get]
String^	CacheLoaderLibrary [get]
ICacheWriter< TKey, TValue >^	CacheWriter [get]
String^	CacheWriterFactory [get]
String^	CacheWriterLibrary [get]
bool	CachingEnabled [get]
virtual uint32_t	ClassId [get]
bool	ClientNotificationEnabled [get]
bool	CloningEnabled [get]
bool	ConcurrencyChecksEnabled [get]
int32_t	ConcurrencyLevel [get]
DiskPolicyType	DiskPolicy [get]
String^	Endpoints [get]
int32_t	EntryIdleTimeout [get]
ExpirationAction	EntryIdleTimeoutAction [get]
int32_t	EntryTimeToLive [get]
ExpirationAction	EntryTimeToLiveAction [get]
int32_t	InitialCapacity [get]
Single	LoadFactor [get]
uint32_t	LruEntriesLimit [get]
ExpirationAction	LruEvictionAction [get]
virtual uint32_t	ObjectSize [get]
IPartitionResolver < TKey, TValue >^	PartitionResolver [get]
String^	PartitionResolverFactory [get]
String^	PartitionResolverLibrary [get]
String^	PersistenceFactory [get]
String^	PersistenceLibrary [get]
Properties< String^ , String^ >^	PersistenceProperties [get]
String^	PoolName [get]
int32_t	RegionIdleTimeout [get]
ExpirationAction	RegionIdleTimeoutAction [get]
int32_t	RegionTimeToLive [get]
ExpirationAction	RegionTimeToLiveAction [get]
ScopeType	Scope [get]

---

Member Function Documentation

void GemStone::GemFire::Cache::Generic::Internal::SBWrap< gemfire::RegionAttributes >::_SetNativePtr

(

gemfire::RegionAttributes *

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::RegionAttributes >::AssignPtr

(

gemfire::RegionAttributes *

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.

template<class TKey, class TValue>

virtual bool GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::Equals

(

Object^

other

)

[override, virtual]

True if all the attributes are equal to those of other.

Parameters:

other

attribute object to compare

Returns:

true if equal

template<class TKey, class TValue>

bool GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::Equals

(

RegionAttributes< TKey, TValue >^

other

)

True if all the attributes are equal to those of other.

Parameters:

other

attribute object to compare

Returns:

true if equal

template<class TKey, class TValue>

virtual IGFSerializable ^ GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::FromData

(

DataInput^

input

)

[virtual]

Deserializes this Properties object.

Parameters:

input

the DataInput stream to use for reading data

Returns:

the deserialized Properties object

Implements GemStone::GemFire::Cache::Generic::IGFSerializable.

void GemStone::GemFire::Cache::Generic::Internal::SBWrap< gemfire::RegionAttributes >::InternalCleanup

(

)

[inline, protected, inherited]

Internal cleanup function invoked by dispose/finalizer.

void GemStone::GemFire::Cache::Generic::Internal::SBWrap< gemfire::RegionAttributes >::SetPtr

(

gemfire::RegionAttributes *

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.

template<class TKey, class TValue>

virtual void GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::ToData

(

DataOutput^

output

)

[virtual]

Serializes this Properties object.

Parameters:

output

the DataOutput stream to use for serialization

Implements GemStone::GemFire::Cache::Generic::IGFSerializable.

String ^ GemStone::GemFire::Cache::Generic::IGFSerializable::ToString

(

)

[inherited]

Return a string representation of the object.

Implemented in GemStone::GemFire::Cache::Generic::CacheableBuiltinKey< TNative, TManaged, TYPEID >, GemStone::GemFire::Cache::Generic::CacheableBuiltinArray< TNative, TNativePtr, TManaged, TYPEID >, GemStone::GemFire::Cache::Generic::CacheableDate, GemStone::GemFire::Cache::Generic::CacheableFileName, GemStone::GemFire::Cache::Generic::CacheableObject, GemStone::GemFire::Cache::Generic::CacheableObjectXml, GemStone::GemFire::Cache::Generic::CacheableStringArray, GemStone::GemFire::Cache::Generic::CacheableString, GemStone::GemFire::Cache::Generic::Properties< TPropKey, TPropValue >, GemStone::GemFire::Cache::Generic::Serializable, GemStone::GemFire::Cache::Generic::CacheableBuiltinKey< gemfire::CacheableFloat, Single, GemFireClassIds::CacheableFloat >, GemStone::GemFire::Cache::Generic::CacheableBuiltinKey< gemfire::CacheableByte, Byte, GemFireClassIds::CacheableByte >, GemStone::GemFire::Cache::Generic::CacheableBuiltinKey< gemfire::CacheableWideChar, Char, GemFireClassIds::CacheableCharacter >, GemStone::GemFire::Cache::Generic::CacheableBuiltinKey< gemfire::CacheableDouble, Double, GemFireClassIds::CacheableDouble >, GemStone::GemFire::Cache::Generic::CacheableBuiltinKey< gemfire::CacheableInt64, int64_t, GemFireClassIds::CacheableInt64 >, GemStone::GemFire::Cache::Generic::CacheableBuiltinKey< gemfire::CacheableBoolean, bool, GemFireClassIds::CacheableBoolean >, GemStone::GemFire::Cache::Generic::CacheableBuiltinKey< gemfire::CacheableInt16, int16_t, GemFireClassIds::CacheableInt16 >, GemStone::GemFire::Cache::Generic::CacheableBuiltinKey< gemfire::CacheableInt32, int32_t, GemFireClassIds::CacheableInt32 >, GemStone::GemFire::Cache::Generic::CacheableBuiltinArray< gemfire::CacheableBytes, gemfire::CacheableBytesPtr, Byte, GemFireClassIds::CacheableBytes >, GemStone::GemFire::Cache::Generic::CacheableBuiltinArray< gemfire::CacheableInt32Array, gemfire::CacheableInt32ArrayPtr, int32_t, GemFireClassIds::CacheableInt32Array >, GemStone::GemFire::Cache::Generic::CacheableBuiltinArray< gemfire::CharArray, gemfire::CharArrayPtr, Char, GemFireClassIds::CharArray >, GemStone::GemFire::Cache::Generic::CacheableBuiltinArray< gemfire::CacheableInt64Array, gemfire::CacheableInt64ArrayPtr, int64_t, GemFireClassIds::CacheableInt64Array >, GemStone::GemFire::Cache::Generic::CacheableBuiltinArray< gemfire::CacheableFloatArray, gemfire::CacheableFloatArrayPtr, Single, GemFireClassIds::CacheableFloatArray >, GemStone::GemFire::Cache::Generic::CacheableBuiltinArray< gemfire::CacheableInt16Array, gemfire::CacheableInt16ArrayPtr, int16_t, GemFireClassIds::CacheableInt16Array >, GemStone::GemFire::Cache::Generic::CacheableBuiltinArray< gemfire::CacheableDoubleArray, gemfire::CacheableDoubleArrayPtr, Double, GemFireClassIds::CacheableDoubleArray >, GemStone::GemFire::Cache::Generic::CacheableBuiltinArray< gemfire::BooleanArray, gemfire::BooleanArrayPtr, bool, GemFireClassIds::BooleanArray >, and GemStone::GemFire::Cache::Generic::Properties< String^ , String^ >.

template<class TKey, class TValue>

void GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::ValidateSerializableAttributes

(

)

Throws IllegalStateException if the attributes are not suited for serialization such as those that have a cache callback (listener, loader, or writer) set directly instead of providing the library path and factory function.

Exceptions:

IllegalStateException

if the attributes cannot be serialized

---

Property Documentation

template<class TKey, class TValue>

ICacheListener< TKey, TValue>^ GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::CacheListener [get]

Gets the cache listener for the region.

Returns:

region's ICacheListener or null if none

template<class TKey, class TValue>

String^ GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::CacheListenerFactory [get]

Returns the symbol name of the factory function from which the loader will be created on a cache server.

Returns:

the CacheListener factory function name

template<class TKey, class TValue>

String^ GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::CacheListenerLibrary [get]

Returns the path of the library from which the factory function will be invoked on a cache server.

Returns:

the CacheListener library path

template<class TKey, class TValue>

GemStone:: GemFire:: Cache:: Generic:: ICacheLoader< TKey, TValue>^ GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::CacheLoader [get]

Gets the cache loader for the region.

Returns:

region's ICacheLoader or null if none

template<class TKey, class TValue>

String^ GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::CacheLoaderFactory [get]

Rreturns the symbol name of the factory function from which the loader will be created on a cache server.

Returns:

the CacheLoader factory function name

template<class TKey, class TValue>

String^ GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::CacheLoaderLibrary [get]

Returns the path of the library from which the factory function will be invoked on a cache server.

Returns:

the CacheLoader library path

template<class TKey, class TValue>

ICacheWriter< TKey, TValue>^ GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::CacheWriter [get]

Gets the cache writer for the region.

Returns:

region's ICacheWriter or null if none

template<class TKey, class TValue>

String^ GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::CacheWriterFactory [get]

Returns the symbol name of the factory function from which the loader will be created on a cache server.

Returns:

the CacheWriter factory function name

template<class TKey, class TValue>

String^ GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::CacheWriterLibrary [get]

Returns the path of the library from which the factory function will be invoked on a cache server.

Returns:

the CacheWriter library path

template<class TKey, class TValue>

bool GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::CachingEnabled [get]

If true, this region will store data in the current process.

Returns:

true if caching is enabled

template<class TKey, class TValue>

virtual uint32_t GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::ClassId [get]

Returns the classId of this class for serialization.

Returns:

classId of the Properties class

See also:

../../IGFSerializable.ClassId

Implements GemStone::GemFire::Cache::Generic::IGFSerializable.

template<class TKey, class TValue>

bool GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::ClientNotificationEnabled [get]

True if client notification is enabled.

Returns:

true if enabled

template<class TKey, class TValue>

bool GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::CloningEnabled [get]

True if cloning is enabled for in case of delta.

Returns:

true if enabled

template<class TKey, class TValue>

bool GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::ConcurrencyChecksEnabled [get]

Returns the concurrency check enabled flag of the region

Returns:

the concurrency check enabled flag

See also:

AttributesFactory

template<class TKey, class TValue>

int32_t GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::ConcurrencyLevel [get]

Returns the concurrency level of the entry's local cache.

Returns:

the concurrency level

See also:

AttributesFactory

template<class TKey, class TValue>

DiskPolicyType GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::DiskPolicy [get]

Returns the disk policy type of the region.

Returns:

the disk policy type, default is null

template<class TKey, class TValue>

String^ GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::Endpoints [get]

This method returns the list of endpoints (servername:portnumber) separated by commas.

Returns:

list of endpoints

template<class TKey, class TValue>

int32_t GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::EntryIdleTimeout [get]

Gets the idleTimeout value for entries in this region.

Returns:

the idleTimeout duration for entries in this region, in seconds

template<class TKey, class TValue>

ExpirationAction GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::EntryIdleTimeoutAction [get]

Gets the idleTimeout expiration action for entries in this region.

Returns:

the idleTimeout action for entries in this region

template<class TKey, class TValue>

int32_t GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::EntryTimeToLive [get]

Gets the timeToLive value for entries in this region.

Returns:

the timeToLive duration for entries in this region, in seconds

template<class TKey, class TValue>

ExpirationAction GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::EntryTimeToLiveAction [get]

Gets the timeToLive expiration action for entries in this region.

Returns:

the timeToLive action for entries in this region

template<class TKey, class TValue>

int32_t GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::InitialCapacity [get]

Returns the initial capacity of the entry's local cache.

Returns:

the initial capacity

template<class TKey, class TValue>

Single GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::LoadFactor [get]

Returns the load factor of the entry's local cache.

Returns:

the load factor

template<class TKey, class TValue>

uint32_t GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::LruEntriesLimit [get]

Returns the maximum number of entries this cache will hold before using LRU eviction.

Returns:

the maximum LRU size, or 0 for no limit

template<class TKey, class TValue>

ExpirationAction GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::LruEvictionAction [get]

Returns the ExpirationAction used for LRU Eviction, default is LOCAL_DESTROY.

Returns:

the LRU eviction action

template<class TKey, class TValue>

virtual uint32_t GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::ObjectSize [get]

return the size of this object in bytes

Implements GemStone::GemFire::Cache::Generic::IGFSerializable.

template<class TKey, class TValue>

IPartitionResolver< TKey, TValue>^ GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::PartitionResolver [get]

Gets the partition resolver for the region.

Returns:

region's IPartitionResolver or null if none

template<class TKey, class TValue>

String^ GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::PartitionResolverFactory [get]

Returns the symbol name of the factory function from which the loader will be created on a cache server.

Returns:

the PartitionResolver factory function name

template<class TKey, class TValue>

String^ GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::PartitionResolverLibrary [get]

Returns the path of the library from which the factory function will be invoked on a cache server.

Returns:

the PartitionResolver library path

template<class TKey, class TValue>

String^ GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::PersistenceFactory [get]

Returns the symbol name of the factory function from which the persistence manager will be created on a cache server.

Returns:

the PersistenceManager factory function name

template<class TKey, class TValue>

String^ GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::PersistenceLibrary [get]

Returns the path of the library from which the factory function will be invoked on a cache server.

Returns:

the PersistenceManager library path

template<class TKey, class TValue>

Properties< String^, String^>^ GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::PersistenceProperties [get]

Returns the properties set for persistence.

Returns:

properties for the PersistenceManager

template<class TKey, class TValue>

String^ GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::PoolName [get]

This method returns the name of the attached pool.

Returns:

pool name

template<class TKey, class TValue>

int32_t GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::RegionIdleTimeout [get]

Gets the idleTimeout value for the region as a whole.

Returns:

the IdleTimeout duration for this region, in seconds

template<class TKey, class TValue>

ExpirationAction GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::RegionIdleTimeoutAction [get]

Gets the idleTimeout expiration action for the region as a whole.

Returns:

the idleTimeout action for this region

template<class TKey, class TValue>

int32_t GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::RegionTimeToLive [get]

Gets the timeToLive value for the region as a whole.

Returns:

the timeToLive duration for this region, in seconds

template<class TKey, class TValue>

ExpirationAction GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::RegionTimeToLiveAction [get]

Gets the timeToLive expiration action for the region as a whole.

Returns:

the timeToLive action for this region

template<class TKey, class TValue>

ScopeType GemStone::GemFire::Cache::Generic::RegionAttributes< TKey, TValue >::Scope [get]

Returns the scope of the region.

Returns:

the region's scope

---