GemStone::GemFire::Cache::Generic::RegionFactory Class Reference

Inherits GemStone::GemFire::Cache::Generic::Internal::SBWrap< gemfire::RegionFactory >.


Detailed Description

This interface provides for the configuration and creation of instances of Region.

Public Member Functions

template<class TKey, class TValue>
IRegion< TKey, TValue >^ Create (String^ regionName)
template<class TKey, class TValue>
RegionFactorySetCacheListener (ICacheListener< TKey, TValue >^cacheListener)
RegionFactorySetCacheListener (String^ libPath, String^ factoryFunctionName)
template<class TKey, class TValue>
RegionFactorySetCacheLoader (ICacheLoader< TKey, TValue >^cacheLoader)
RegionFactorySetCacheLoader (String^ libPath, String^ factoryFunctionName)
template<class TKey, class TValue>
RegionFactorySetCacheWriter (ICacheWriter< TKey, TValue >^cacheWriter)
RegionFactorySetCacheWriter (String^ libPath, String^ factoryFunctionName)
RegionFactorySetCachingEnabled (bool cachingEnabled)
RegionFactorySetCloningEnabled (bool cloningEnabled)
RegionFactorySetConcurrencyChecksEnabled (bool concurrencyChecksEnabled)
RegionFactorySetConcurrencyLevel (int32_t concurrencyLevel)
RegionFactorySetDiskPolicy (DiskPolicyType diskPolicy)
RegionFactorySetEntryIdleTimeout (ExpirationAction action, uint32_t idleTimeout)
RegionFactorySetEntryTimeToLive (ExpirationAction action, uint32_t timeToLive)
RegionFactorySetInitialCapacity (int32_t initialCapacity)
RegionFactorySetLoadFactor (Single loadFactor)
RegionFactorySetLruEntriesLimit (uint32_t entriesLimit)
template<class TKey, class TValue>
RegionFactorySetPartitionResolver (IPartitionResolver< TKey, TValue >^partitionresolver)
RegionFactorySetPartitionResolver (String^ libPath, String^ factoryFunctionName)
RegionFactorySetPersistenceManager (String^ libPath, String^ factoryFunctionName, Properties< String^ , String^ >^config)
RegionFactorySetPersistenceManager (String^ libPath, String^ factoryFunctionName)
template<class TKey, class TValue>
RegionFactorySetPersistenceManager (Generic::IPersistenceManager< TKey, TValue >^persistenceManager, Properties< String^ , String^ >^config)
template<class TKey, class TValue>
RegionFactorySetPersistenceManager (Generic::IPersistenceManager< TKey, TValue >^persistenceManager)
RegionFactorySetPoolName (String^ poolName)
RegionFactorySetRegionIdleTimeout (ExpirationAction action, uint32_t idleTimeout)
RegionFactorySetRegionTimeToLive (ExpirationAction action, uint32_t timeToLive)

Protected Member Functions

void _SetNativePtr (gemfire::RegionFactory *nativeptr)
void AssignPtr (gemfire::RegionFactory *nativeptr)
void InternalCleanup ()
void SetPtr (gemfire::RegionFactory *nativeptr)

Member Function Documentation

void GemStone::GemFire::Cache::Generic::Internal::SBWrap< gemfire::RegionFactory >::_SetNativePtr ( gemfire::RegionFactory *  nativeptr  )  [inline, protected, inherited]

Set the native pointer to the new object without doing a preserveSB(). DO NOT USE UNLESS YOU KNOW WHAT YOU ARE DOING.

void GemStone::GemFire::Cache::Generic::Internal::SBWrap< gemfire::RegionFactory >::AssignPtr ( gemfire::RegionFactory *  nativeptr  )  [inline, protected, inherited]

Used to assign the native pointer to a new object.

Note the order of preserveSB() and releaseSB(). This handles the corner case when m_nativeptr is same as nativeptr.

template<class TKey, class TValue>
IRegion<TKey, TValue> ^ GemStone::GemFire::Cache::Generic::RegionFactory::Create ( String^   regionName  )  [explicit]

Creates a region with the given name. The region is just created locally. It is not created on the server to which this client is connected with.

If Pool attached with Region is in multiusersecure mode then don't use return instance of region as no credential are attached with this instance. Get instance of region from <see cref="Cache.CreateAuthenticatedView" to do the operation on Cache.

Parameters:
name the name of the region to create
Returns:
new region
Exceptions:
RegionExistsException if a region with the same name is already in this cache
CacheClosedException if the cache is closed
OutOfMemoryException if the memory allocation failed
RegionCreationFailedException if the call fails due to incomplete mirror initialization
InitFailedException if the optional PersistenceManager fails to initialize
UnknownException otherwise

void GemStone::GemFire::Cache::Generic::Internal::SBWrap< gemfire::RegionFactory >::InternalCleanup (  )  [inline, protected, inherited]

Internal cleanup function invoked by dispose/finalizer.

template<class TKey, class TValue>
RegionFactory ^ GemStone::GemFire::Cache::Generic::RegionFactory::SetCacheListener ( ICacheListener< TKey, TValue >^  cacheListener  )  [explicit]

Sets the CacheListener for the RegionAttributes being created.

Parameters:
cacheListener user-defined cache listener, or null for no cache listener
Returns:
the instance of RegionFactory

RegionFactory ^ GemStone::GemFire::Cache::Generic::RegionFactory::SetCacheListener ( String^   libPath,
String^   factoryFunctionName 
)

Sets the library path for the library that will be invoked for the listener of the region.

Parameters:
libPath library pathname containing the factory function.
factoryFunctionName Name of factory function that creates a CacheListener for a native library, or the name of the method in the form {Namespace}.{Class Name}.{Method Name} that creates an ICacheListener for a managed library.
Returns:
the instance of RegionFactory

template<class TKey, class TValue>
RegionFactory ^ GemStone::GemFire::Cache::Generic::RegionFactory::SetCacheLoader ( ICacheLoader< TKey, TValue >^  cacheLoader  )  [explicit]

Sets the cache loader for the RegionAttributes being created.

Parameters:
cacheLoader a user-defined cache loader, or null for no cache loader
Returns:
the instance of RegionFactory

RegionFactory ^ GemStone::GemFire::Cache::Generic::RegionFactory::SetCacheLoader ( String^   libPath,
String^   factoryFunctionName 
)

Sets the library path for the library that will be invoked for the loader of the region.

Parameters:
libPath library pathname containing the factory function.
factoryFunctionName Name of factory function that creates a CacheLoader for a native library, or the name of the method in the form {Namespace}.{Class Name}.{Method Name} that creates an ICacheLoader for a managed library.
Returns:
the instance of RegionFactory

template<class TKey, class TValue>
RegionFactory ^ GemStone::GemFire::Cache::Generic::RegionFactory::SetCacheWriter ( ICacheWriter< TKey, TValue >^  cacheWriter  )  [explicit]

Sets the cache writer for the RegionAttributes being created.

Parameters:
cacheWriter user-defined cache writer, or null for no cache writer
Returns:
the instance of RegionFactory

RegionFactory ^ GemStone::GemFire::Cache::Generic::RegionFactory::SetCacheWriter ( String^   libPath,
String^   factoryFunctionName 
)

Sets the library path for the library that will be invoked for the writer of the region.

Parameters:
libPath library pathname containing the factory function.
factoryFunctionName Name of factory function that creates a CacheWriter for a native library, or the name of the method in the form {Namespace}.{Class Name}.{Method Name} that creates an ICacheWriter for a managed library.
Returns:
the instance of RegionFactory

RegionFactory ^ GemStone::GemFire::Cache::Generic::RegionFactory::SetCachingEnabled ( bool  cachingEnabled  ) 

Set caching enabled flag for this region.

If set to false, then no data is stored in the local process, but events and distributions will still occur, and the region can still be used to put and remove, etc...

The default if not set is 'true', 'false' is illegal for regions of ScopeType.Local scope.

Parameters:
cachingEnabled if true, cache data for this region in this process.
Returns:
the instance of RegionFactory

RegionFactory ^ GemStone::GemFire::Cache::Generic::RegionFactory::SetCloningEnabled ( bool  cloningEnabled  ) 

Set cloning enabled flag for this region.

If set to false, then there is no cloning will take place in case of delta. Delta will be applied on the old value which will change old value in-place.

The default if not set is 'false' of ScopeType.Local scope.

Parameters:
cloningEnabled if true, clone old value before applying delta so that in-place change would not occour..
Returns:
the instance of RegionFactory

RegionFactory ^ GemStone::GemFire::Cache::Generic::RegionFactory::SetConcurrencyChecksEnabled ( bool  concurrencyChecksEnabled  ) 

Sets concurrency checks enabled flag for this region.

If set to false, then the version checks will not occur.

The default if not set is 'true'

Parameters:
concurrencyChecksEnabled if true, version checks for region entries will occur.
Returns:
the instance of RegionFactory

RegionFactory ^ GemStone::GemFire::Cache::Generic::RegionFactory::SetConcurrencyLevel ( int32_t  concurrencyLevel  ) 

Sets the concurrency level of the next RegionAttributes created. This value is used in initializing the map that holds the entries.

Parameters:
concurrencyLevel the concurrency level of the entry map
Exceptions:
IllegalArgumentException if concurrencyLevel is nonpositive
Returns:
the instance of RegionFactory

RegionFactory ^ GemStone::GemFire::Cache::Generic::RegionFactory::SetDiskPolicy ( DiskPolicyType  diskPolicy  ) 

Sets the disk policy type for the next RegionAttributes created.

Parameters:
diskPolicy the disk policy to use for the region
Returns:
the instance of RegionFactory

RegionFactory ^ GemStone::GemFire::Cache::Generic::RegionFactory::SetEntryIdleTimeout ( ExpirationAction  action,
uint32_t  idleTimeout 
)

Sets the idleTimeout expiration attributes for region entries for the next RegionAttributes created.

Parameters:
action The expiration action for which to set the timeout.
idleTimeout the idleTimeout in seconds for entries in this region.
Returns:
the instance of RegionFactory

RegionFactory ^ GemStone::GemFire::Cache::Generic::RegionFactory::SetEntryTimeToLive ( ExpirationAction  action,
uint32_t  timeToLive 
)

Sets the timeToLive expiration attributes for region entries for the next RegionAttributes created.

Parameters:
action The expiration action for which to set the timeout.
timeToLive the timeToLive in seconds for entries in this region.
Returns:
the instance of RegionFactory

RegionFactory ^ GemStone::GemFire::Cache::Generic::RegionFactory::SetInitialCapacity ( int32_t  initialCapacity  ) 

Sets the entry initial capacity for the RegionAttributes being created. This value is used in initializing the map that holds the entries.

Parameters:
initialCapacity the initial capacity of the entry map
Exceptions:
IllegalArgumentException if initialCapacity is nonpositive
Returns:
the instance of RegionFactory

RegionFactory ^ GemStone::GemFire::Cache::Generic::RegionFactory::SetLoadFactor ( Single  loadFactor  ) 

Sets the entry load factor for the next RegionAttributes created. This value is used in initializing the map that holds the entries.

Parameters:
loadFactor the load factor of the entry map
Exceptions:
IllegalArgumentException if loadFactor is nonpositive
Returns:
the instance of RegionFactory

RegionFactory ^ GemStone::GemFire::Cache::Generic::RegionFactory::SetLruEntriesLimit ( uint32_t  entriesLimit  ) 

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.

Parameters:
entriesLimit The limit of the number of entries before eviction starts. Defaults to 0, meaning no LRU actions will used.
Returns:
the instance of RegionFactory

template<class TKey, class TValue>
RegionFactory ^ GemStone::GemFire::Cache::Generic::RegionFactory::SetPartitionResolver ( IPartitionResolver< TKey, TValue >^  partitionresolver  )  [explicit]

Sets the PartitionResolver for the RegionAttributes being created.

Parameters:
partitionresolver user-defined partition resolver, or null for no partition resolver
Returns:
the instance of RegionFactory

RegionFactory ^ GemStone::GemFire::Cache::Generic::RegionFactory::SetPartitionResolver ( String^   libPath,
String^   factoryFunctionName 
)

Sets the library path for the library that will be invoked for the partition resolver of the region.

Parameters:
libPath library pathname containing the factory function.
factoryFunctionName Name of factory function that creates a PartitionResolver for a native library, or the name of the method in the form {Namespace}.{Class Name}.{Method Name} that creates an IPartitionResolver for a managed library.
Returns:
the instance of RegionFactory

RegionFactory ^ GemStone::GemFire::Cache::Generic::RegionFactory::SetPersistenceManager ( String^   libPath,
String^   factoryFunctionName,
Properties< String^ , String^ >^  config 
)

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.

Parameters:
libPath The path of the PersistenceManager shared library.
factoryFunctionName The name of the factory function to create an instance of PersistenceManager object.
config The configuration properties to use for the PersistenceManager.
Returns:
the instance of RegionFactory

RegionFactory ^ GemStone::GemFire::Cache::Generic::RegionFactory::SetPersistenceManager ( String^   libPath,
String^   factoryFunctionName 
)

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.

Parameters:
libPath The path of the PersistenceManager shared library.
factoryFunctionName The name of the factory function to create an instance of PersistenceManager object.
Returns:
the instance of RegionFactory

template<class TKey, class TValue>
RegionFactory ^ GemStone::GemFire::Cache::Generic::RegionFactory::SetPersistenceManager ( Generic::IPersistenceManager< TKey, TValue >^  persistenceManager,
Properties< String^ , String^ >^  config 
) [explicit]

Sets the persistence manager for the RegionAttributes being created.

Parameters:
persistenceManager a user-defined persistence manager, or null for no persistence manager
config The configuration properties to use for the PersistenceManager.
Returns:
the instance of RegionFactory

template<class TKey, class TValue>
RegionFactory ^ GemStone::GemFire::Cache::Generic::RegionFactory::SetPersistenceManager ( Generic::IPersistenceManager< TKey, TValue >^  persistenceManager  )  [explicit]

Sets the persistence manager for the RegionAttributes being created.

Parameters:
persistenceManager a user-defined persistence manager, or null for no persistence manager
Returns:
the instance of RegionFactory

RegionFactory ^ GemStone::GemFire::Cache::Generic::RegionFactory::SetPoolName ( String^   poolName  ) 

Set the pool name for a Thin Client region.

The pool with the name specified must be already created.

Parameters:
poolName The name of the pool to attach to this region.
Returns:
the instance of RegionFactory

void GemStone::GemFire::Cache::Generic::Internal::SBWrap< gemfire::RegionFactory >::SetPtr ( gemfire::RegionFactory *  nativeptr  )  [inline, protected, inherited]

Used to set the native pointer to a new object. This should only be used when you know that the underlying object is NULL.

RegionFactory ^ GemStone::GemFire::Cache::Generic::RegionFactory::SetRegionIdleTimeout ( ExpirationAction  action,
uint32_t  idleTimeout 
)

Sets the idleTimeout expiration attributes for the region itself for the next RegionAttributes created.

Parameters:
action The expiration action for which to set the timeout.
idleTimeout the idleTimeout in seconds for the region as a whole.
Returns:
the instance of RegionFactory

RegionFactory ^ GemStone::GemFire::Cache::Generic::RegionFactory::SetRegionTimeToLive ( ExpirationAction  action,
uint32_t  timeToLive 
)

Sets the timeToLive expiration attributes for the region itself for the next RegionAttributes created.

Parameters:
action The expiration action for which to set the timeout.
timeToLive the timeToLive in seconds for the region as a whole.
Returns:
the instance of RegionFactory


GemFire C++ Cache .NET API Documentation