RegionAttributes Class

Note: This API is now obsolete.

Defines attributes for configuring a region.

Inheritance Hierarchy

SystemObject
[T:GemStone.GemFire.Cache.Internal.SBWrap<gemfire::RegionAttributes>]
GemStone.GemFire.CacheRegionAttributes

Namespace: GemStone.GemFire.Cache
Assembly: Gemstone.Gemfire.Cache (in Gemstone.Gemfire.Cache.dll) Version: 9.0.6.18

Syntax

C++

Copy

[ObsoleteAttribute("Use classes and APIs from the GemStone.GemFire.Cache.Generic namespace")]
public sealed class RegionAttributes : [T:GemStone.GemFire.Cache.Internal.SBWrap<gemfire::RegionAttributes>], 
	IGFSerializable

<ObsoleteAttribute("Use classes and APIs from the GemStone.GemFire.Cache.Generic namespace")>
Public NotInheritable Class RegionAttributes
	Inherits [T:GemStone.GemFire.Cache.Internal.SBWrap<gemfire::RegionAttributes>]
	Implements IGFSerializable

[ObsoleteAttribute(L"Use classes and APIs from the GemStone.GemFire.Cache.Generic namespace")]
public ref class RegionAttributes sealed : public [T:GemStone.GemFire.Cache.Internal.SBWrap<gemfire::RegionAttributes>], 
	IGFSerializable

[<SealedAttribute>]
[<ObsoleteAttribute("Use classes and APIs from the GemStone.GemFire.Cache.Generic namespace")>]
type RegionAttributes =  
    class
        inherit [T:GemStone.GemFire.Cache.Internal.SBWrap<gemfire::RegionAttributes>]
        interface IGFSerializable
    end

The RegionAttributes type exposes the following members.

Properties

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

Top

Methods

	Name	Description
	Equals(Object)	True if all the attributes are equal to those of other. (Overrides ObjectEquals(Object).)
	Equals(RegionAttributes)	True if all the attributes are equal to those of other.
	FromData	Deserializes this Properties object.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToData	Serializes this Properties object.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	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.

Top

Remarks

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.

Reference

GemStone.GemFire.Cache Namespace

GemStone.GemFire.CacheAttributesFactory

GemStone.GemFire.CacheAttributesMutator

[!:Region.Attributes]