|
Pivotal GemFire Native C++ Reference
10.0.5
|
Public Member Functions | |
| AttributesMutator (const std::shared_ptr< Region > ®ion) | |
| Internal constructor. More... | |
| void | setCacheListener (const std::shared_ptr< CacheListener > &aListener) |
| Sets cache listener for region. More... | |
| void | setCacheListener (const std::string &libpath, const std::string &factoryFuncName) |
| Sets cache listener for region. More... | |
| void | setCacheLoader (const std::shared_ptr< CacheLoader > &aLoader) |
| Sets cache loader for region. More... | |
| void | setCacheLoader (const std::string &libpath, const std::string &factoryFuncName) |
| Sets cache loader for region. More... | |
| void | setCacheWriter (const std::shared_ptr< CacheWriter > &aWriter) |
| Sets cache writer for region. More... | |
| void | setCacheWriter (const std::string &libpath, const std::string &factoryFuncName) |
| Sets cache writer for region. More... | |
| std::chrono::seconds | setEntryIdleTimeout (std::chrono::seconds idleTimeout) |
| Sets the idleTimeout duration for region entries. More... | |
| ExpirationAction | setEntryIdleTimeoutAction (ExpirationAction action) |
| Set the idleTimeout Action for region entries. More... | |
| std::chrono::seconds | setEntryTimeToLive (std::chrono::seconds timeToLive) |
| Sets the timeToLive duration for region entries. More... | |
| ExpirationAction | setEntryTimeToLiveAction (ExpirationAction action) |
| Set the timeToLive Action for region entries. More... | |
| uint32_t | setLruEntriesLimit (uint32_t entriesLimit) |
| Sets the Maximum entry count in the region before LRU eviction. More... | |
| std::chrono::seconds | setRegionIdleTimeout (std::chrono::seconds idleTimeout) |
| Sets the idleTimeout duration for the region itself. More... | |
| ExpirationAction | setRegionIdleTimeoutAction (ExpirationAction action) |
| Set the idleTimeout Action for the region itself. More... | |
| std::chrono::seconds | setRegionTimeToLive (std::chrono::seconds timeToLive) |
| Sets the timeToLive duration for the region itself. More... | |
| ExpirationAction | setRegionTimeToLiveAction (ExpirationAction action) |
| Set the timeToLive Action for the region itself. More... | |
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.
|
explicit |
Internal constructor.
Use Region::getAttributesMutator() to acquire the mutator for a region.
| void apache::geode::client::AttributesMutator::setCacheListener | ( | const std::shared_ptr< CacheListener > & | aListener | ) |
Sets cache listener for region.
The previous cache listener will be replaced with aListener.
| aListener | cache listener |
| void apache::geode::client::AttributesMutator::setCacheListener | ( | const std::string & | libpath, |
| const std::string & | factoryFuncName | ||
| ) |
Sets cache listener for region.
The previous cache listener will be replaced with a listener created using the factory function provided in the given library.
| libpath | path of the library containing cache listener factory function. |
| factoryFuncName | factory function for creating cache listener. |
| void apache::geode::client::AttributesMutator::setCacheLoader | ( | const std::shared_ptr< CacheLoader > & | aLoader | ) |
Sets cache loader for region.
The previous cache loader will be replaced with aLoader.
| aLoader | cache loader |
| void apache::geode::client::AttributesMutator::setCacheLoader | ( | const std::string & | libpath, |
| const std::string & | factoryFuncName | ||
| ) |
Sets cache loader for region.
The previous cache loader will be replaced with a loader created using the factory function provided in the given library.
| libpath | path of the library containing cache loader factory function. |
| factoryFuncName | factory function for creating cache loader. |
| void apache::geode::client::AttributesMutator::setCacheWriter | ( | const std::shared_ptr< CacheWriter > & | aWriter | ) |
Sets cache writer for region.
The previous cache writer will be replaced with aWriter.
| aWriter | cache writer |
| void apache::geode::client::AttributesMutator::setCacheWriter | ( | const std::string & | libpath, |
| const std::string & | factoryFuncName | ||
| ) |
Sets cache writer for region.
The previous cache writer will be replaced with a writer created using the factory function provided in the given library.
| libpath | path of the library containing cache writer factory function. |
| factoryFuncName | factory function for creating cache writer. |
| std::chrono::seconds apache::geode::client::AttributesMutator::setEntryIdleTimeout | ( | std::chrono::seconds | idleTimeout | ) |
Sets the idleTimeout duration for region entries.
| idleTimeout | the idleTimeout for entries in this region. |
| IllegalStateException | if the new idleTimeout changes entry expiration from disabled to enabled or enabled to disabled. |
| ExpirationAction apache::geode::client::AttributesMutator::setEntryIdleTimeoutAction | ( | ExpirationAction | action | ) |
Set the idleTimeout Action for region entries.
| action | the idleTimeout ExpirationAction for entries in this region. |
| std::chrono::seconds apache::geode::client::AttributesMutator::setEntryTimeToLive | ( | std::chrono::seconds | timeToLive | ) |
Sets the timeToLive duration for region entries.
| timeToLive | the timeToLive for entries in this region. |
| IllegalStateException | if the new timeToLive changes entry expiration from disabled to enabled or enabled to disabled. |
| ExpirationAction apache::geode::client::AttributesMutator::setEntryTimeToLiveAction | ( | ExpirationAction | action | ) |
Set the timeToLive Action for region entries.
| action | the timeToLive ExpirationAction for entries in this region. |
| uint32_t apache::geode::client::AttributesMutator::setLruEntriesLimit | ( | uint32_t | entriesLimit | ) |
Sets the Maximum entry count in the region before LRU eviction.
| entriesLimit | the number of entries to allow. |
| IllegalStateException | if the new entriesLimit changes LRU from disabled to enabled or enabled to disabled. |
| std::chrono::seconds apache::geode::client::AttributesMutator::setRegionIdleTimeout | ( | std::chrono::seconds | idleTimeout | ) |
Sets the idleTimeout duration for the region itself.
| idleTimeout | the ExpirationAttributes for this region idleTimeout |
| IllegalStateException | if the new idleTimeout changes region expiration from disabled to enabled or enabled to disabled. |
| ExpirationAction apache::geode::client::AttributesMutator::setRegionIdleTimeoutAction | ( | ExpirationAction | action | ) |
Set the idleTimeout Action for the region itself.
| action | the idleTimeout ExpirationAction for this region. |
| std::chrono::seconds apache::geode::client::AttributesMutator::setRegionTimeToLive | ( | std::chrono::seconds | timeToLive | ) |
Sets the timeToLive duration for the region itself.
| timeToLive | the ExpirationAttributes for this region timeToLive |
| IllegalStateException | if the new timeToLive changes region expiration from disabled to enabled or enabled to disabled. |
| ExpirationAction apache::geode::client::AttributesMutator::setRegionTimeToLiveAction | ( | ExpirationAction | action | ) |
Set the timeToLive Action for the region itself.
| action | the timeToLive ExpirationAction for this region. |