GemStone::GemFire::Cache::AttributesMutator Class Reference


Detailed Description

Supports modification of certain region attributes after the region has been created.

It is required that the attributes be completely initialized using an AttributesFactory before creating the region. AttributesMutator can be applied to adjusting and tuning a subset of attributes that are modifiable at runtime.

The setter methods all return the previous value of the attribute.

See also:
Region.GetAttributesMutator, RegionAttributes, AttributesFactory


Public Member Functions

void SetCacheListener (String^ libPath, String^ factoryFunctionName)
void SetCacheListener (ICacheListener^ cacheListener)
void SetCacheLoader (String^ libPath, String^ factoryFunctionName)
void SetCacheLoader (ICacheLoader^ cacheLoader)
void SetCacheWriter (String^ libPath, String^ factoryFunctionName)
void SetCacheWriter (ICacheWriter^ cacheWriter)
int32_t SetEntryIdleTimeout (int32_t idleTimeout)
ExpirationAction SetEntryIdleTimeoutAction (ExpirationAction action)
int32_t SetEntryTimeToLive (int32_t timeToLive)
ExpirationAction SetEntryTimeToLiveAction (ExpirationAction action)
uint32_t SetLruEntriesLimit (uint32_t entriesLimit)
int32_t SetRegionIdleTimeout (int32_t idleTimeout)
ExpirationAction SetRegionIdleTimeoutAction (ExpirationAction action)
int32_t SetRegionTimeToLive (int32_t timeToLive)
ExpirationAction SetRegionTimeToLiveAction (ExpirationAction action)

Member Function Documentation

void GemStone::GemFire::Cache::AttributesMutator::SetCacheListener ( String^   libPath,
String^   factoryFunctionName 
)

Sets the library path for the library that will be invoked for the listener of the region. The previous cache listener will be replaced with a listener created using the factory function provided in the given library.

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.

void GemStone::GemFire::Cache::AttributesMutator::SetCacheListener ( ICacheListener^   cacheListener  ) 

Sets the CacheListener for the region. The previous cache listener (if any) will be replaced with the given cacheListener.

Parameters:
cacheListener user-defined cache listener, or null for no cache listener

void GemStone::GemFire::Cache::AttributesMutator::SetCacheLoader ( String^   libPath,
String^   factoryFunctionName 
)

Sets the library path for the library that will be invoked for the loader of the region. The previous cache loader will be replaced with a loader created using the factory function provided in the given library.

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.

void GemStone::GemFire::Cache::AttributesMutator::SetCacheLoader ( ICacheLoader^   cacheLoader  ) 

Sets the CacheLoader for the region. The previous cache loader (if any) will be replaced with the given cacheLoader.

Parameters:
cacheLoader user-defined cache loader, or null for no cache loader

void GemStone::GemFire::Cache::AttributesMutator::SetCacheWriter ( String^   libPath,
String^   factoryFunctionName 
)

Sets the library path for the library that will be invoked for the writer of the region. The previous cache writer will be replaced with a writer created using the factory function provided in the given library.

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.

void GemStone::GemFire::Cache::AttributesMutator::SetCacheWriter ( ICacheWriter^   cacheWriter  ) 

Sets the CacheListener for the region. The previous cache writer (if any) will be replaced with the given cacheWriter.

Parameters:
cacheWriter user-defined cache writer, or null for no cache writer

int32_t GemStone::GemFire::Cache::AttributesMutator::SetEntryIdleTimeout ( int32_t  idleTimeout  ) 

Sets the idleTimeout duration for region entries.

Parameters:
idleTimeout the idleTimeout in seconds for entries in this region, or 0 for no idle timeout
Returns:
the previous value
Exceptions:
IllegalStateException if the new idleTimeout changes entry expiration from disabled to enabled or enabled to disabled.

ExpirationAction GemStone::GemFire::Cache::AttributesMutator::SetEntryIdleTimeoutAction ( ExpirationAction  action  ) 

Sets the idleTimeout action for region entries.

Parameters:
action the idleTimeout action for entries in this region
Returns:
the previous action

int32_t GemStone::GemFire::Cache::AttributesMutator::SetEntryTimeToLive ( int32_t  timeToLive  ) 

Sets the timeToLive duration for region entries.

Parameters:
timeToLive the timeToLive in seconds for entries in this region, or 0 to disable time-to-live
Returns:
the previous value
Exceptions:
IllegalStateException if the new timeToLive changes entry expiration from disabled to enabled or enabled to disabled

ExpirationAction GemStone::GemFire::Cache::AttributesMutator::SetEntryTimeToLiveAction ( ExpirationAction  action  ) 

Set the timeToLive action for region entries.

Parameters:
action the timeToLive action for entries in this region
Returns:
the previous action

uint32_t GemStone::GemFire::Cache::AttributesMutator::SetLruEntriesLimit ( uint32_t  entriesLimit  ) 

Sets the maximum entry count in the region before LRU eviction.

Parameters:
entriesLimit the number of entries to allow, or 0 to disable LRU
Returns:
the previous value
Exceptions:
IllegalStateException if the new entriesLimit changes LRU from disabled to enabled or enabled to disabled.

int32_t GemStone::GemFire::Cache::AttributesMutator::SetRegionIdleTimeout ( int32_t  idleTimeout  ) 

Sets the idleTimeout duration for the region itself.

Parameters:
idleTimeout the idleTimeout for this region, in seconds, or 0 to disable idle timeout
Returns:
the previous value
Exceptions:
IllegalStateException if the new idleTimeout changes region expiration from disabled to enabled or enabled to disabled.

ExpirationAction GemStone::GemFire::Cache::AttributesMutator::SetRegionIdleTimeoutAction ( ExpirationAction  action  ) 

Sets the idleTimeout action for the region itself.

Parameters:
action the idleTimeout action for this region
Returns:
the previous action

int32_t GemStone::GemFire::Cache::AttributesMutator::SetRegionTimeToLive ( int32_t  timeToLive  ) 

Sets the timeToLive duration for the region itself.

Parameters:
timeToLive the timeToLive for this region, in seconds, or 0 to disable time-to-live
Returns:
the previous value
Exceptions:
IllegalStateException if the new timeToLive changes region expiration from disabled to enabled or enabled to disabled.

ExpirationAction GemStone::GemFire::Cache::AttributesMutator::SetRegionTimeToLiveAction ( ExpirationAction  action  ) 

Sets the timeToLive action for the region itself.

Parameters:
action the timeToLiv eaction for this region
Returns:
the previous action


GemFire C++ Cache .NET API Documentation