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

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

Public Member Functions

void SetCacheListener (ICacheListener< TKey, TValue >^ cacheListener)
 Sets the CacheListener for the region. More...
 
void SetCacheListener (String^ libPath, String^ factoryFunctionName)
 Sets the library path for the library that will be invoked for the listener of the region. More...
 
void SetCacheLoader (ICacheLoader< TKey, TValue >^ cacheLoader)
 Sets the CacheLoader for the region. More...
 
void SetCacheLoader (String^ libPath, String^ factoryFunctionName)
 Sets the library path for the library that will be invoked for the loader of the region. More...
 
void SetCacheWriter (ICacheWriter< TKey, TValue >^ cacheWriter)
 Sets the CacheListener for the region. More...
 
void SetCacheWriter (String^ libPath, String^ factoryFunctionName)
 Sets the library path for the library that will be invoked for the writer of the region. More...
 
TimeSpan SetEntryIdleTimeout (TimeSpan idleTimeout)
 Sets the idleTimeout duration for region entries. More...
 
ExpirationAction SetEntryIdleTimeoutAction (ExpirationAction action)
 Sets the idleTimeout action for region entries. More...
 
TimeSpan SetEntryTimeToLive (TimeSpan timeToLive)
 Sets the timeToLive duration for region entries. More...
 
ExpirationAction SetEntryTimeToLiveAction (ExpirationAction action)
 Set the timeToLive action for region entries. More...
 
System::UInt32 SetLruEntriesLimit (System::UInt32 entriesLimit)
 Sets the maximum entry count in the region before LRU eviction. More...
 
TimeSpan SetRegionIdleTimeout (TimeSpan idleTimeout)
 Sets the idleTimeout duration for the region itself. More...
 
ExpirationAction SetRegionIdleTimeoutAction (ExpirationAction action)
 Sets the idleTimeout action for the region itself. More...
 
TimeSpan SetRegionTimeToLive (TimeSpan timeToLive)
 Sets the timeToLive duration for the region itself. More...
 
ExpirationAction SetRegionTimeToLiveAction (ExpirationAction action)
 Sets the timeToLive action for the region itself. More...
 

Detailed Description

template<class TKey, class TValue>
class Apache::Geode::Client::AttributesMutator< TKey, TValue >

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

It is required that the attributes be completely initialized using an RegionAttributesFactory 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.AttributesMutator, RegionAttributes, RegionAttributesFactory

Member Function Documentation

◆ SetCacheListener() [1/2]

template<class TKey , class TValue >
void Apache::Geode::Client::AttributesMutator< TKey, TValue >::SetCacheListener ( ICacheListener< TKey, TValue >^  cacheListener)

Sets the CacheListener for the region.

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

Parameters
cacheListeneruser-defined cache listener, or null for no cache listener

◆ SetCacheListener() [2/2]

template<class TKey , class TValue >
void Apache::Geode::Client::AttributesMutator< TKey, TValue >::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
libPathlibrary pathname containing the factory function.
factoryFunctionNameName 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.

◆ SetCacheLoader() [1/2]

template<class TKey , class TValue >
void Apache::Geode::Client::AttributesMutator< TKey, TValue >::SetCacheLoader ( ICacheLoader< TKey, TValue >^  cacheLoader)

Sets the CacheLoader for the region.

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

Parameters
cacheLoaderuser-defined cache loader, or null for no cache loader

◆ SetCacheLoader() [2/2]

template<class TKey , class TValue >
void Apache::Geode::Client::AttributesMutator< TKey, TValue >::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
libPathlibrary pathname containing the factory function.
factoryFunctionNameName 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.

◆ SetCacheWriter() [1/2]

template<class TKey , class TValue >
void Apache::Geode::Client::AttributesMutator< TKey, TValue >::SetCacheWriter ( ICacheWriter< TKey, TValue >^  cacheWriter)

Sets the CacheListener for the region.

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

Parameters
cacheWriteruser-defined cache writer, or null for no cache writer

◆ SetCacheWriter() [2/2]

template<class TKey , class TValue >
void Apache::Geode::Client::AttributesMutator< TKey, TValue >::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
libPathlibrary pathname containing the factory function.
factoryFunctionNameName 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.

◆ SetEntryIdleTimeout()

template<class TKey , class TValue >
TimeSpan Apache::Geode::Client::AttributesMutator< TKey, TValue >::SetEntryIdleTimeout ( TimeSpan  idleTimeout)

Sets the idleTimeout duration for region entries.

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

◆ SetEntryIdleTimeoutAction()

template<class TKey , class TValue >
ExpirationAction Apache::Geode::Client::AttributesMutator< TKey, TValue >::SetEntryIdleTimeoutAction ( ExpirationAction  action)

Sets the idleTimeout action for region entries.

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

◆ SetEntryTimeToLive()

template<class TKey , class TValue >
TimeSpan Apache::Geode::Client::AttributesMutator< TKey, TValue >::SetEntryTimeToLive ( TimeSpan  timeToLive)

Sets the timeToLive duration for region entries.

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

◆ SetEntryTimeToLiveAction()

template<class TKey , class TValue >
ExpirationAction Apache::Geode::Client::AttributesMutator< TKey, TValue >::SetEntryTimeToLiveAction ( ExpirationAction  action)

Set the timeToLive action for region entries.

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

◆ SetLruEntriesLimit()

template<class TKey , class TValue >
System::UInt32 Apache::Geode::Client::AttributesMutator< TKey, TValue >::SetLruEntriesLimit ( System::UInt32  entriesLimit)

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

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

◆ SetRegionIdleTimeout()

template<class TKey , class TValue >
TimeSpan Apache::Geode::Client::AttributesMutator< TKey, TValue >::SetRegionIdleTimeout ( TimeSpan  idleTimeout)

Sets the idleTimeout duration for the region itself.

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

◆ SetRegionIdleTimeoutAction()

template<class TKey , class TValue >
ExpirationAction Apache::Geode::Client::AttributesMutator< TKey, TValue >::SetRegionIdleTimeoutAction ( ExpirationAction  action)

Sets the idleTimeout action for the region itself.

Parameters
actionthe idleTimeout action for this region
Returns
the previous action

◆ SetRegionTimeToLive()

template<class TKey , class TValue >
TimeSpan Apache::Geode::Client::AttributesMutator< TKey, TValue >::SetRegionTimeToLive ( TimeSpan  timeToLive)

Sets the timeToLive duration for the region itself.

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

◆ SetRegionTimeToLiveAction()

template<class TKey , class TValue >
ExpirationAction Apache::Geode::Client::AttributesMutator< TKey, TValue >::SetRegionTimeToLiveAction ( ExpirationAction  action)

Sets the timeToLive action for the region itself.

Parameters
actionthe timeToLiv eaction for this region
Returns
the previous action

Apache Geode C++ Cache .NET API Documentation