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

Defines attributes for configuring a region. More...

#include <RegionAttributes.hpp>

Inherits Apache::Geode::Client::IDataSerializableInternal.

Public Member Functions
virtual bool	Equals (Object^ other) override
	True if all the attributes are equal to those of other.
bool	Equals (RegionAttributes< TKey, TValue >^ other)
	True if all the attributes are equal to those of other.
virtual void	FromData (DataInput^ input)
	Deserializes this Properties object.
virtual void	ToData (DataOutput^ output)
	Serializes this Properties object.
String ^	ToString ()
	Return a string representation of the object.
void	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.

Properties
ICacheListener< TKey, TValue >^	CacheListener [get]
	Gets the cache listener for the region.
String^	CacheListenerFactory [get]
	Returns the symbol name of the factory function from which the loader will be created on a cache server.
String^	CacheListenerLibrary [get]
	Returns the path of the library from which the factory function will be invoked on a cache server.
Apache::Geode::Client::ICacheLoader< TKey, TValue >^	CacheLoader [get]
	Gets the cache loader for the region.
String^	CacheLoaderFactory [get]
	Rreturns the symbol name of the factory function from which the loader will be created on a cache server.
String^	CacheLoaderLibrary [get]
	Returns the path of the library from which the factory function will be invoked on a cache server.
ICacheWriter< TKey, TValue >^	CacheWriter [get]
	Gets the cache writer for the region.
String^	CacheWriterFactory [get]
	Returns the symbol name of the factory function from which the loader will be created on a cache server.
String^	CacheWriterLibrary [get]
	Returns the path of the library from which the factory function will be invoked on a cache server.
bool	CachingEnabled [get]
	If true, this region will store data in the current process.
bool	ClientNotificationEnabled [get]
	True if client notification is enabled.
bool	CloningEnabled [get]
	True if cloning is enabled for in case of delta.
bool	ConcurrencyChecksEnabled [get]
	Returns the concurrency check enabled flag of the region.
System::Int32	ConcurrencyLevel [get]
	Returns the concurrency level of the entry's local cache.
DiskPolicyType	DiskPolicy [get]
	Returns the disk policy type of the region.
String^	Endpoints [get]
	This method returns the list of endpoints (servername:portnumber) separated by commas.
TimeSpan	EntryIdleTimeout [get]
	Gets the idleTimeout value for entries in this region.
ExpirationAction	EntryIdleTimeoutAction [get]
	Gets the idleTimeout expiration action for entries in this region.
TimeSpan	EntryTimeToLive [get]
	Gets the timeToLive value for entries in this region.
ExpirationAction	EntryTimeToLiveAction [get]
	Gets the timeToLive expiration action for entries in this region.
System::Int32	InitialCapacity [get]
	Returns the initial capacity of the entry's local cache.
Single	LoadFactor [get]
	Returns the load factor of the entry's local cache.
System::UInt32	LruEntriesLimit [get]
	Returns the maximum number of entries this cache will hold before using LRU eviction.
ExpirationAction	LruEvictionAction [get]
	Returns the ExpirationAction used for LRU Eviction, default is LOCAL_DESTROY.
virtual System::UInt64	ObjectSize [get]
	return the size of this object in bytes
IPartitionResolver< TKey, TValue >^	PartitionResolver [get]
	Gets the partition resolver for the region.
String^	PartitionResolverFactory [get]
	Returns the symbol name of the factory function from which the loader will be created on a cache server.
String^	PartitionResolverLibrary [get]
	Returns the path of the library from which the factory function will be invoked on a cache server.
String^	PersistenceFactory [get]
	Returns the symbol name of the factory function from which the persistence manager will be created on a cache server.
String^	PersistenceLibrary [get]
	Returns the path of the library from which the factory function will be invoked on a cache server.
Properties< String^, String^>^	PersistenceProperties [get]
	Returns the properties set for persistence.
String^	PoolName [get]
	This method returns the name of the attached pool.
TimeSpan	RegionIdleTimeout [get]
	Gets the idleTimeout value for the region as a whole.
ExpirationAction	RegionIdleTimeoutAction [get]
	Gets the idleTimeout expiration action for the region as a whole.
TimeSpan	RegionTimeToLive [get]
	Gets the timeToLive value for the region as a whole.
ExpirationAction	RegionTimeToLiveAction [get]
	Gets the timeToLive expiration action for the region as a whole.

Detailed Description

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

For compatibility rules and default values, see RegionAttributesFactory.

Note that the RegionAttributes are not distributed with the region.

See also

RegionAttributesFactory, AttributesMutator, Region.Attributes

Member Function Documentation

Equals() [1/2]

template<class TKey , class TValue >

virtual bool Apache::Geode::Client::RegionAttributes< TKey, TValue >::Equals ( Object^  other )

overridevirtual

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

Parameters

other

attribute object to compare

Returns

true if equal

Equals() [2/2]

template<class TKey , class TValue >

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

FromData()

template<class TKey , class TValue >

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

ToData()

template<class TKey , class TValue >

virtual void Apache::Geode::Client::RegionAttributes< TKey, TValue >::ToData ( DataOutput^  output )

virtual

Serializes this Properties object.

Parameters

output

the DataOutput stream to use for serialization

ToString()

String ^ Apache::Geode::Client::ISerializable::ToString ( )

inherited

Return a string representation of the object.

Implemented in Apache::Geode::Client::CacheableBuiltinKey< TNative, TManaged, TYPEID >, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableBoolean, bool, static_cast< int8_t >(DSCode::CacheableBoolean)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableByte, Byte, static_cast< int8_t >(DSCode::CacheableByte)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableCharacter, Char, static_cast< int8_t >(DSCode::CacheableCharacter)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableDouble, Double, static_cast< int8_t >(DSCode::CacheableDouble)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableFloat, Single, static_cast< int8_t >(DSCode::CacheableFloat)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableInt16, System::Int16, static_cast< int8_t >(DSCode::CacheableInt16)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableInt32, System::Int32, static_cast< int8_t >(DSCode::CacheableInt32)>, Apache::Geode::Client::CacheableBuiltinKey< native::CacheableInt64, System::Int64, static_cast< int8_t >(DSCode::CacheableInt64)>, Apache::Geode::Client::CacheableBuiltinArray< TNative, TNativePtr, TManaged, TYPEID >, Apache::Geode::Client::CacheableBuiltinArray< NativeArray, NativeArray, ManagedType, DsCode >, Apache::Geode::Client::CacheableDate, Apache::Geode::Client::CacheableFileName, Apache::Geode::Client::CacheableObject, Apache::Geode::Client::CacheableObjectXml, Apache::Geode::Client::CacheableString, Apache::Geode::Client::CacheableStringArray, Apache::Geode::Client::Properties< TPropKey, TPropValue >, Apache::Geode::Client::Properties< String^, String^>, and Apache::Geode::Client::Serializable.

ValidateSerializableAttributes()

template<class TKey , class TValue >

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

CacheListener

template<class TKey , class TValue >

ICacheListener< TKey, TValue>^ Apache::Geode::Client::RegionAttributes< TKey, TValue >::CacheListener

get

Gets the cache listener for the region.

Returns

region's ICacheListener or null if none

CacheListenerFactory

template<class TKey , class TValue >

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

CacheListenerLibrary

template<class TKey , class TValue >

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

CacheLoader

template<class TKey , class TValue >

Apache:: Geode:: Client:: ICacheLoader< TKey, TValue>^ Apache::Geode::Client::RegionAttributes< TKey, TValue >::CacheLoader

get

Gets the cache loader for the region.

Returns

region's ICacheLoader or null if none

CacheLoaderFactory

template<class TKey , class TValue >

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

CacheLoaderLibrary

template<class TKey , class TValue >

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

CacheWriter

template<class TKey , class TValue >

ICacheWriter< TKey, TValue>^ Apache::Geode::Client::RegionAttributes< TKey, TValue >::CacheWriter

get

Gets the cache writer for the region.

Returns

region's ICacheWriter or null if none

CacheWriterFactory

template<class TKey , class TValue >

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

CacheWriterLibrary

template<class TKey , class TValue >

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

CachingEnabled

template<class TKey , class TValue >

bool Apache::Geode::Client::RegionAttributes< TKey, TValue >::CachingEnabled

get

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

Returns

true if caching is enabled

ClientNotificationEnabled

template<class TKey , class TValue >

bool Apache::Geode::Client::RegionAttributes< TKey, TValue >::ClientNotificationEnabled

get

True if client notification is enabled.

Returns

true if enabled

CloningEnabled

template<class TKey , class TValue >

bool Apache::Geode::Client::RegionAttributes< TKey, TValue >::CloningEnabled

get

True if cloning is enabled for in case of delta.

Returns

true if enabled

ConcurrencyChecksEnabled

template<class TKey , class TValue >

bool Apache::Geode::Client::RegionAttributes< TKey, TValue >::ConcurrencyChecksEnabled

get

Returns the concurrency check enabled flag of the region.

Returns

the concurrency check enabled flag

See also

RegionAttributesFactory

ConcurrencyLevel

template<class TKey , class TValue >

System:: Int32 Apache::Geode::Client::RegionAttributes< TKey, TValue >::ConcurrencyLevel

get

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

Returns

the concurrency level

See also

RegionAttributesFactory

DiskPolicy

template<class TKey , class TValue >

DiskPolicyType Apache::Geode::Client::RegionAttributes< TKey, TValue >::DiskPolicy

get

Returns the disk policy type of the region.

Returns

the disk policy type, default is null

Endpoints

template<class TKey , class TValue >

String^ Apache::Geode::Client::RegionAttributes< TKey, TValue >::Endpoints

get

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

Returns

list of endpoints

EntryIdleTimeout

template<class TKey , class TValue >

TimeSpan Apache::Geode::Client::RegionAttributes< TKey, TValue >::EntryIdleTimeout

get

Gets the idleTimeout value for entries in this region.

Returns

the idleTimeout duration for entries in this region

EntryIdleTimeoutAction

template<class TKey , class TValue >

ExpirationAction Apache::Geode::Client::RegionAttributes< TKey, TValue >::EntryIdleTimeoutAction

get

Gets the idleTimeout expiration action for entries in this region.

Returns

the idleTimeout action for entries in this region

EntryTimeToLive

template<class TKey , class TValue >

TimeSpan Apache::Geode::Client::RegionAttributes< TKey, TValue >::EntryTimeToLive

get

Gets the timeToLive value for entries in this region.

Returns

the timeToLive duration for entries in this region

EntryTimeToLiveAction

template<class TKey , class TValue >

ExpirationAction Apache::Geode::Client::RegionAttributes< TKey, TValue >::EntryTimeToLiveAction

get

Gets the timeToLive expiration action for entries in this region.

Returns

the timeToLive action for entries in this region

InitialCapacity

template<class TKey , class TValue >

System:: Int32 Apache::Geode::Client::RegionAttributes< TKey, TValue >::InitialCapacity

get

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

Returns

the initial capacity

LoadFactor

template<class TKey , class TValue >

Single Apache::Geode::Client::RegionAttributes< TKey, TValue >::LoadFactor

get

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

Returns

the load factor

LruEntriesLimit

template<class TKey , class TValue >

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

LruEvictionAction

template<class TKey , class TValue >

ExpirationAction Apache::Geode::Client::RegionAttributes< TKey, TValue >::LruEvictionAction

get

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

Returns

the LRU eviction action

ObjectSize

template<class TKey , class TValue >

virtual System:: UInt64 Apache::Geode::Client::RegionAttributes< TKey, TValue >::ObjectSize

get

return the size of this object in bytes

PartitionResolver

template<class TKey , class TValue >

IPartitionResolver< TKey, TValue>^ Apache::Geode::Client::RegionAttributes< TKey, TValue >::PartitionResolver

get

Gets the partition resolver for the region.

Returns

region's IPartitionResolver or null if none

PartitionResolverFactory

template<class TKey , class TValue >

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

PartitionResolverLibrary

template<class TKey , class TValue >

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

PersistenceFactory

template<class TKey , class TValue >

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

PersistenceLibrary

template<class TKey , class TValue >

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

PersistenceProperties

template<class TKey , class TValue >

Properties< String^, String^>^ Apache::Geode::Client::RegionAttributes< TKey, TValue >::PersistenceProperties

get

Returns the properties set for persistence.

Returns

properties for the PersistenceManager

PoolName

template<class TKey , class TValue >

String^ Apache::Geode::Client::RegionAttributes< TKey, TValue >::PoolName

get

This method returns the name of the attached pool.

Returns

pool name

RegionIdleTimeout

template<class TKey , class TValue >

TimeSpan Apache::Geode::Client::RegionAttributes< TKey, TValue >::RegionIdleTimeout

get

Gets the idleTimeout value for the region as a whole.

Returns

the IdleTimeout duration for this region

RegionIdleTimeoutAction

template<class TKey , class TValue >

ExpirationAction Apache::Geode::Client::RegionAttributes< TKey, TValue >::RegionIdleTimeoutAction

get

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

Returns

the idleTimeout action for this region

RegionTimeToLive

template<class TKey , class TValue >

TimeSpan Apache::Geode::Client::RegionAttributes< TKey, TValue >::RegionTimeToLive

get

Gets the timeToLive value for the region as a whole.

Returns

the timeToLive duration for this region

RegionTimeToLiveAction

template<class TKey , class TValue >

ExpirationAction Apache::Geode::Client::RegionAttributes< TKey, TValue >::RegionTimeToLiveAction

get

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

Returns

the timeToLive action for this region