Pivotal GemFire Native .NET Reference  10.2.0
Apache::Geode::Client::RegionAttributes< TKey, TValue > Class Template Reference

Defines attributes for configuring a region. More...

Public Member Functions

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

Properties

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

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
otherattribute 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
otherattribute 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
inputthe 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
outputthe DataOutput stream to use for serialization

◆ 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
IllegalStateExceptionif 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

Apache Geode C++ Cache .NET API Documentation