GemStone::GemFire::Cache::RegionAttributes Class Reference

Inherits GemStone::GemFire::Cache::IGFSerializable.

---

Detailed Description

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 Boolean	Equals (Object^ other) override
Boolean	Equals (RegionAttributes^ other)
virtual IGFSerializable^	FromData (DataInput^ input)
virtual void	ToData (DataOutput^ output)
String^	ToString ()
void	ValidateSerializableAttributes ()
Properties
ICacheListener^	CacheListener [get]
String^	CacheListenerFactory [get]
String^	CacheListenerLibrary [get]
ICacheLoader^	CacheLoader [get]
String^	CacheLoaderFactory [get]
String^	CacheLoaderLibrary [get]
ICacheWriter^	CacheWriter [get]
String^	CacheWriterFactory [get]
String^	CacheWriterLibrary [get]
Boolean	CachingEnabled [get]
virtual UInt32	ClassId [get]
Boolean	ClientNotificationEnabled [get]
Int32	ConcurrencyLevel [get]
DiskPolicyType	DiskPolicy [get]
String^	Endpoints [get]
Int32	EntryIdleTimeout [get]
ExpirationAction	EntryIdleTimeoutAction [get]
Int32	EntryTimeToLive [get]
ExpirationAction	EntryTimeToLiveAction [get]
Int32	InitialCapacity [get]
Single	LoadFactor [get]
UInt32	LruEntriesLimit [get]
ExpirationAction	LruEvictionAction [get]
virtual UInt32	ObjectSize [get]
String^	PersistenceFactory [get]
String^	PersistenceLibrary [get]
Properties^	PersistenceProperties [get]
Int32	RegionIdleTimeout [get]
ExpirationAction	RegionIdleTimeoutAction [get]
Int32	RegionTimeToLive [get]
ExpirationAction	RegionTimeToLiveAction [get]
ScopeType	Scope [get]

---

Member Function Documentation

virtual Boolean GemStone::GemFire::Cache::RegionAttributes::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

Boolean GemStone::GemFire::Cache::RegionAttributes::Equals

(

RegionAttributes^

other

)

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

Parameters:

other

attribute object to compare

Returns:

true if equal

virtual IGFSerializable ^ GemStone::GemFire::Cache::RegionAttributes::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::IGFSerializable.

virtual void GemStone::GemFire::Cache::RegionAttributes::ToData

(

DataOutput^

output

)

[virtual]

Serializes this Properties object.

Parameters:

output

the DataOutput stream to use for serialization

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

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

(

)

[inherited]

Return a string representation of the object.

Implemented in GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< TNative, TManaged, TYPEID >, GemStone::GemFire::Cache::CacheableDate, GemStone::GemFire::Cache::CacheableFileName, GemStone::GemFire::Cache::CacheableObject, GemStone::GemFire::Cache::CacheableObjectXml, GemStone::GemFire::Cache::CacheableString, GemStone::GemFire::Cache::Properties, GemStone::GemFire::Cache::Serializable, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableFloat, Single, GemFireClassIds::CacheableFloat >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableInt64, Int64, GemFireClassIds::CacheableInt64 >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableByte, Byte, GemFireClassIds::CacheableByte >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableWideChar, Char, GemFireClassIds::CacheableCharacter >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableInt16, Int16, GemFireClassIds::CacheableInt16 >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableDouble, Double, GemFireClassIds::CacheableDouble >, GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableInt32, Int32, GemFireClassIds::CacheableInt32 >, and GemStone::GemFire::Cache::Internal::CacheableBuiltinKey< gemfire::CacheableBoolean, Boolean, GemFireClassIds::CacheableBoolean >.

void GemStone::GemFire::Cache::RegionAttributes::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

ICacheListener^ GemStone::GemFire::Cache::RegionAttributes::CacheListener [get]

Gets the cache listener for the region.

Returns:

region's ICacheListener or null if none

String^ GemStone::GemFire::Cache::RegionAttributes::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

String^ GemStone::GemFire::Cache::RegionAttributes::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

ICacheLoader^ GemStone::GemFire::Cache::RegionAttributes::CacheLoader [get]

Gets the cache loader for the region.

Returns:

region's ICacheLoader or null if none

String^ GemStone::GemFire::Cache::RegionAttributes::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

String^ GemStone::GemFire::Cache::RegionAttributes::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

ICacheWriter^ GemStone::GemFire::Cache::RegionAttributes::CacheWriter [get]

Gets the cache writer for the region.

Returns:

region's ICacheWriter or null if none

String^ GemStone::GemFire::Cache::RegionAttributes::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

String^ GemStone::GemFire::Cache::RegionAttributes::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

Boolean GemStone::GemFire::Cache::RegionAttributes::CachingEnabled [get]

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

Returns:

true if caching is enabled

virtual UInt32 GemStone::GemFire::Cache::RegionAttributes::ClassId [get]

Returns the classId of this class for serialization.

Returns:

classId of the Properties class

See also:

IGFSerializable.ClassId

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

Boolean GemStone::GemFire::Cache::RegionAttributes::ClientNotificationEnabled [get]

True if client notification is enabled.

Returns:

true if enabled

Int32 GemStone::GemFire::Cache::RegionAttributes::ConcurrencyLevel [get]

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

Returns:

the concurrency level

See also:

AttributesFactory

DiskPolicyType GemStone::GemFire::Cache::RegionAttributes::DiskPolicy [get]

Returns the disk policy type of the region.

Returns:

the disk policy type, default is null

String^ GemStone::GemFire::Cache::RegionAttributes::Endpoints [get]

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

Returns:

list of endpoints

Int32 GemStone::GemFire::Cache::RegionAttributes::EntryIdleTimeout [get]

Gets the idleTimeout value for entries in this region.

Returns:

the idleTimeout duration for entries in this region, in seconds

ExpirationAction GemStone::GemFire::Cache::RegionAttributes::EntryIdleTimeoutAction [get]

Gets the idleTimeout expiration action for entries in this region.

Returns:

the idleTimeout action for entries in this region

Int32 GemStone::GemFire::Cache::RegionAttributes::EntryTimeToLive [get]

Gets the timeToLive value for entries in this region.

Returns:

the timeToLive duration for entries in this region, in seconds

ExpirationAction GemStone::GemFire::Cache::RegionAttributes::EntryTimeToLiveAction [get]

Gets the timeToLive expiration action for entries in this region.

Returns:

the timeToLive action for entries in this region

Int32 GemStone::GemFire::Cache::RegionAttributes::InitialCapacity [get]

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

Returns:

the initial capacity

Single GemStone::GemFire::Cache::RegionAttributes::LoadFactor [get]

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

Returns:

the load factor

UInt32 GemStone::GemFire::Cache::RegionAttributes::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

ExpirationAction GemStone::GemFire::Cache::RegionAttributes::LruEvictionAction [get]

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

Returns:

the LRU eviction action

virtual UInt32 GemStone::GemFire::Cache::RegionAttributes::ObjectSize [get]

return the size of this object in bytes

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

String^ GemStone::GemFire::Cache::RegionAttributes::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

String^ GemStone::GemFire::Cache::RegionAttributes::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

Properties^ GemStone::GemFire::Cache::RegionAttributes::PersistenceProperties [get]

Returns the properties set for persistence.

Returns:

properties for the PersistenceManager

Int32 GemStone::GemFire::Cache::RegionAttributes::RegionIdleTimeout [get]

Gets the idleTimeout value for the region as a whole.

Returns:

the IdleTimeout duration for this region, in seconds

ExpirationAction GemStone::GemFire::Cache::RegionAttributes::RegionIdleTimeoutAction [get]

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

Returns:

the idleTimeout action for this region

Int32 GemStone::GemFire::Cache::RegionAttributes::RegionTimeToLive [get]

Gets the timeToLive value for the region as a whole.

Returns:

the timeToLive duration for this region, in seconds

ExpirationAction GemStone::GemFire::Cache::RegionAttributes::RegionTimeToLiveAction [get]

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

Returns:

the timeToLive action for this region

ScopeType GemStone::GemFire::Cache::RegionAttributes::Scope [get]

Returns the scope of the region.

Returns:

the region's scope

---