Factory class to create instances of RegionAttributes.

Namespace: GemStone.GemFire.Cache
Assembly: GemStone.GemFire.Cache (in GemStone.GemFire.Cache.dll) Version: 8.2.4.0

Syntax

         
 C#  Visual Basic  Visual C++ 
[ObsoleteAttribute("Use classes and APIs from the GemStone.GemFire.Cache.Generic namespace")]
public sealed class AttributesFactory : [T:GemStone.GemFire.Cache.Internal.UMWrap<gemfire::AttributesFactory>]
<ObsoleteAttribute("Use classes and APIs from the GemStone.GemFire.Cache.Generic namespace")> _
Public NotInheritable Class AttributesFactory _
	Inherits [T:GemStone.GemFire.Cache.Internal.UMWrap<gemfire::AttributesFactory>]
[ObsoleteAttribute(L"Use classes and APIs from the GemStone.GemFire.Cache.Generic namespace")]
public ref class AttributesFactory sealed : public [T:GemStone.GemFire.Cache.Internal.UMWrap<gemfire::AttributesFactory>]

Members

         
 All Members  Constructors   Methods  
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

 MemberDescription
AttributesFactory()()()()
Creates a new AttributesFactory ready to create a RegionAttributes with default settings.
AttributesFactory(RegionAttributes)
Creates a new instance of AttributesFactory ready to create a RegionAttributes with the same settings as those in the specified RegionAttributes.
CreateRegionAttributes()()()()
Creates a RegionAttributes with the current settings.
Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the Type of the current instance.
(Inherited from Object.)
SetCacheListener(ICacheListener)
Sets the CacheListener for the RegionAttributes being created.
SetCacheListener(String, String)
Sets the library path for the library that will be invoked for the listener of the region.
SetCacheLoader(ICacheLoader)
Sets the cache loader for the RegionAttributes being created.
SetCacheLoader(String, String)
Sets the library path for the library that will be invoked for the loader of the region.
SetCacheWriter(ICacheWriter)
Sets the cache writer for the RegionAttributes being created.
SetCacheWriter(String, String)
Sets the library path for the library that will be invoked for the writer of the region.
SetCachingEnabled(Boolean)
Set caching enabled flag for this region.
SetClientNotificationEnabled(Boolean) Obsolete.
Enables/disables client noficiations for a Thin client region.
SetCloningEnabled(Boolean)
Set cloning enabled flag for this region.
SetConcurrencyChecksEnabled(Boolean)
Sets concurrency checks enabled flag for this region.
SetConcurrencyLevel(Int32)
Sets the concurrency level of the next RegionAttributes created. This value is used in initializing the map that holds the entries.
SetDiskPolicy(DiskPolicyType)
Sets the disk policy type for the next RegionAttributes created.
SetEndpoints(String) Obsolete.
Set the endpoints for a Thin Client region.
SetEntryIdleTimeout(ExpirationAction, UInt32)
Sets the idleTimeout expiration attributes for region entries for the next RegionAttributes created.
SetEntryTimeToLive(ExpirationAction, UInt32)
Sets the timeToLive expiration attributes for region entries for the next RegionAttributes created.
SetInitialCapacity(Int32)
Sets the entry initial capacity for the RegionAttributes being created. This value is used in initializing the map that holds the entries.
SetLoadFactor(Single)
Sets the entry load factor for the next RegionAttributes created. This value is used in initializing the map that holds the entries.
SetLruEntriesLimit(UInt32)
Sets a limit on the number of entries that will be held in the cache. If a new entry is added while at the limit, the cache will evict the least recently used entry.
SetPartitionResolver(IPartitionResolver)
Sets the PartitionResolver for the RegionAttributes being created.
SetPartitionResolver(String, String)
Sets the library path for the library that will be invoked for the partition resolver of the region.
SetPersistenceManager(String, String)
Sets the library path for the library that will be invoked for the persistence of the region. If the region is being created from a client on a server, or on a server directly, then This must be used to set the PersistenceManager.
SetPersistenceManager(String, String, Properties)
Sets the library path for the library that will be invoked for the persistence of the region. If the region is being created from a client on a server, or on a server directly, then This must be used to set the PersistenceManager.
SetPoolName(String)
Set the pool name for a Thin Client region.
SetRegionIdleTimeout(ExpirationAction, UInt32)
Sets the idleTimeout expiration attributes for the region itself for the next RegionAttributes created.
SetRegionTimeToLive(ExpirationAction, UInt32)
Sets the timeToLive expiration attributes for the region itself for the next RegionAttributes created.
SetScope(ScopeType) Obsolete.
Sets the scope for the next RegionAttributes created.
ToString()()()()
Returns a String that represents the current Object.
(Inherited from Object.)

Remarks

An AttributesFactory instance maintains state for creating RegionAttributes instances. The setter methods are used to change the settings that will be used for creating the next attributes instance with the CreateRegionAttributes()()()() method. If you create a factory with the default constructor, then the factory is set up to create attributes with all default settings. You can also create a factory by providing a preset RegionAttributes.

Once a RegionAttributes is created, it can only be modified after it has been used to create a Region, and then only by using an AttributesMutator obtained from the region.

Attributes

Callbacks

ICacheLoader [default: null]
User-implemented plug-in for loading data on cache misses.
see SetCacheLoader(ICacheLoader), CacheLoader
ICacheWriter [default: null]
User-implemented plug-in for intercepting cache modifications, e.g. for writing to an external data source.
see SetCacheWriter(ICacheWriter), CacheWriter
ICacheListener [default: null]
User-implemented plug-in for receiving and handling cache-related events.
see SetCacheListener(ICacheListener), CacheListener
IPartitionResolver [default: null]
User-implemented plug-in for custom partitioning.
see SetPartitionResolver(IPartitionResolver), PartitionResolver

Expiration

RegionTimeToLive [default: no expiration]
Expiration configuration for the entire region based on the lastModifiedTime ( LastModifiedTime ).
see SetRegionTimeToLive(ExpirationAction, UInt32), RegionTimeToLive, SetRegionTimeToLive(Int32)
RegionIdleTimeout [default: no expiration]
Expiration configuration for the entire region based on the lastAccessedTime ( LastAccessedTime ).
see SetRegionIdleTimeout(ExpirationAction, UInt32), RegionIdleTimeout, SetRegionIdleTimeout(Int32)
EntryTimeToLive [default: no expiration]
Expiration configuration for individual entries based on the lastModifiedTime ( LastModifiedTime ).
see SetEntryTimeToLive(ExpirationAction, UInt32), EntryTimeToLive, SetEntryTimeToLive(Int32)
EntryIdleTimeout [default: no expiration]
Expiration configuration for individual entries based on the lastAccessedTime ( LastAccessedTime ).
see SetEntryIdleTimeout(ExpirationAction, UInt32), EntryIdleTimeout, SetEntryIdleTimeout(Int32)

Distribution

ScopeType [default:ScopeType.DistributedNoAck]
The C++ cache can contain either local regions or distributed regions. Distributed regions are configured with servers that they distribute their operations to upto. Locally scoped regions do not have any distribution behavior. GFE native client regions scoped as ScopeType.DistributedNoAck and ScopeType.DistributedAck have identical distribution behavior.
see SetScope(ScopeType), Scope

Storage

InitialCapacity [default:16]
The initial capacity of the map used for storing the entries.
see SetInitialCapacity(Int32), InitialCapacity
LoadFactor [default:0.75]
The load factor of the map used for storing the entries.
see SetLoadFactor(Single), LoadFactor
ConcurrencyLevel [default:16]
The allowed concurrency among updates to values in the region is guided by the concurrencyLevel, which is used as a hint for internal sizing. The actual concurrency will vary. Ideally, you should choose a value to accommodate as many threads as will ever concurrently modify values in the region. Using a significantly higher value than you need can waste space and time, and a significantly lower value can lead to thread contention. But overestimates and underestimates within an order of magnitude do not usually have much noticeable impact. A value of one is appropriate when it is known that only one thread will modify and all others will only read.
see SetConcurrencyLevel(Int32), ConcurrencyLevel

Inheritance Hierarchy

System..::..Object
  [T:GemStone.GemFire.Cache.Internal.UMWrap<gemfire::AttributesFactory>]
    GemStone.GemFire.Cache..::..AttributesFactory

See Also