These are CacheListener, CacheLoader, CacheWriter, scope, mirroring, and expiration attributes for the region itself; expiration attributes for the region entries; and whether statistics are enabled for the region and its entries.
To create an instance of this interface, use AttributesFactory::createRegionAttributes.
For compatibility rules and default values, see AttributesFactory.
Note that the RegionAttributes are not distributed with the region.
Public Member Functions | |
| virtual int8_t | classId () const |
| Return class id for serialization. | |
| virtual Serializable * | fromData (DataInput &in) |
| Initialize members from serialized data. | |
| CacheListenerPtr | getCacheListener () |
| Gets the cache listener for the region. | |
| const char * | getCacheListenerFactory () |
| This method returns the symbol name of the factory function from which the loader will be created on a cache server. | |
| const char * | getCacheListenerLibrary () |
| This method returns the path of the library from which the factory function will be invoked on a cache server. | |
| CacheLoaderPtr | getCacheLoader () |
| const char * | getCacheLoaderFactory () |
| This method returns the symbol name of the factory function from which the loader will be created on a cache server. | |
| const char * | getCacheLoaderLibrary () |
| This method returns the path of the library from which the factory function will be invoked on a cache server. | |
| CacheWriterPtr | getCacheWriter () |
| Gets the cache writer for the region. | |
| const char * | getCacheWriterFactory () |
| This method returns the symbol name of the factory function from which the loader will be created on a cache server. | |
| const char * | getCacheWriterLibrary () |
| This method returns the path of the library from which the factory function will be invoked on a cache server. | |
| bool | getCachingEnabled () const |
| If true, this region will store data in the current process. | |
| bool | getClientNotificationEnabled () const |
| This method returns the setting of client notification. | |
| int | getConcurrencyLevel () const |
| Returns the concurrencyLevel of the entry's local cache. | |
| DiskPolicyType::PolicyType | getDiskPolicy () const |
| Returns the disk policy type of the region. | |
| const char * | getEndpoints () |
| This method returns the list of servername:portno separated by comma. | |
| int | getEntryIdleTimeout () |
Gets the idleTimeout expiration attributes for entries in this region. | |
| int | getEntryTimeToLive () |
Gets the timeToLive expiration attributes for entries in this region. | |
| int | getInitialCapacity () const |
| Returns the initial capacity of the entry's local cache. | |
| bool | getInterestListEnabled () const |
| This functionality is unsupported in the Native Client Product. | |
| float | getLoadFactor () const |
| Returns the load factor of the entry's local cache. | |
| uint32_t | getLruEntriesLimit () const |
| Returns the maximum number of entries this cache will hold before using LRU eviction. | |
| const ExpirationAction::Action | getLruEvictionAction () const |
| Returns the ExpirationAction used for LRU Eviction, default is LOCAL_DESTROY. | |
| uint32_t | getMaxValueDistLimit () const |
| This functionality is unsupported in the Native Client Product. | |
| bool | getMirroring () const |
| Returns the type of mirroring for this region. | |
| const char * | getPersistenceFactory () |
| This method returns the symbol name of the factory function from which the persistence will be created on a cache server. | |
| const char * | getPersistenceLibrary () |
| This method returns the path of the library from which the factory function will be invoked on a cache server. | |
| PersistenceManagerPtr | getPersistenceManager () |
| Gets the persistence for the region. | |
| PropertiesPtr | getPersistenceProperties () |
| This method returns the properties pointer which is set for persistence. | |
| int | getRegionIdleTimeout () |
| Gets the idleTimeout expiration attributes for the region as a whole. | |
| int | getRegionTimeToLive () |
Gets the timeToLive expiration attributes for the region as a whole. | |
| ScopeType::Scope | getScope () const |
| Returns the scope of the region. | |
| virtual uint32_t | objectSize () const |
| bool | operator!= (const RegionAttributes &other) const |
| Return true if any of the attributes are not equal to those of other. | |
| bool | operator== (const RegionAttributes &other) const |
| Return true if all the attributes are equal to those of other. | |
| void | preserveSB () const |
| Atomically increment reference count. | |
| int32_t | refCount () |
| |
| void | releaseSB () const |
| Atomically decrement reference count, the SharedBase object is automatically deleted when its reference count goes to zero. | |
| virtual void | toData (DataOutput &out) const |
| Serialize out to stream. | |
| virtual CacheableStringPtr | toString () const |
| Display this object as 'string', which depends on the implementation in the subclasses. | |
| virtual int8_t | typeId () const |
| Return type id for serialization. | |
| void | validateSerializableAttributes () |
| throws IllegalStateException if the attributes are not suited for serialization such as those that have a cache callback (listener, loader, or writer) set directly instead of through the string value setters. | |
Static Public Member Functions | |
| template<class PRIM> | |
| static SerializablePtr | create (const PRIM value) |
| Factory method that creates the Serializable object that matches the type of value. | |
| static Serializable * | createDeserializable () |
| Return an empty instance for deserialization. | |
| static void | registerType (TypeFactoryMethod creationFunction) |
| virtual int8_t gemfire::RegionAttributes::classId | ( | ) | const [virtual] |
| static SerializablePtr gemfire::Serializable::create | ( | const PRIM | value | ) | [inline, static, inherited] |
Factory method that creates the Serializable object that matches the type of value.
For customer defined derivations of Serializable, the method gemfire::createValue may be overloaded. For pointer types (e.g. char*) the method gemfire::createValueArr may be overloaded.
Reimplemented in gemfire::CacheableKey.
| static Serializable* gemfire::RegionAttributes::createDeserializable | ( | ) | [static] |
Return an empty instance for deserialization.
| virtual Serializable* gemfire::RegionAttributes::fromData | ( | DataInput & | in | ) | [virtual] |
| CacheListenerPtr gemfire::RegionAttributes::getCacheListener | ( | ) |
Gets the cache listener for the region.
CacheListener , null if there is no CacheListener defined for this region. | const char* gemfire::RegionAttributes::getCacheListenerFactory | ( | ) |
This method returns the symbol name of the factory function from which the loader will be created on a cache server.
| const char* gemfire::RegionAttributes::getCacheListenerLibrary | ( | ) |
This method returns the path of the library from which the factory function will be invoked on a cache server.
| CacheLoaderPtr gemfire::RegionAttributes::getCacheLoader | ( | ) |
public static methods Gets the cache loader for the region.
CacheLoader , null if there is no CacheLoader for this region. | const char* gemfire::RegionAttributes::getCacheLoaderFactory | ( | ) |
This method returns the symbol name of the factory function from which the loader will be created on a cache server.
| const char* gemfire::RegionAttributes::getCacheLoaderLibrary | ( | ) |
This method returns the path of the library from which the factory function will be invoked on a cache server.
| CacheWriterPtr gemfire::RegionAttributes::getCacheWriter | ( | ) |
Gets the cache writer for the region.
CacheWriter , null if there is no CacheWriter for this region | const char* gemfire::RegionAttributes::getCacheWriterFactory | ( | ) |
This method returns the symbol name of the factory function from which the loader will be created on a cache server.
| const char* gemfire::RegionAttributes::getCacheWriterLibrary | ( | ) |
This method returns the path of the library from which the factory function will be invoked on a cache server.
| bool gemfire::RegionAttributes::getCachingEnabled | ( | ) | const |
If true, this region will store data in the current process.
| bool gemfire::RegionAttributes::getClientNotificationEnabled | ( | ) | const |
This method returns the setting of client notification.
| int gemfire::RegionAttributes::getConcurrencyLevel | ( | ) | const |
Returns the concurrencyLevel of the entry's local cache.
| DiskPolicyType::PolicyType gemfire::RegionAttributes::getDiskPolicy | ( | ) | const |
Returns the disk policy type of the region.
DiskPolicyType::PolicyType, default is NULL. | const char* gemfire::RegionAttributes::getEndpoints | ( | ) |
This method returns the list of servername:portno separated by comma.
| int gemfire::RegionAttributes::getEntryIdleTimeout | ( | ) |
Gets the idleTimeout expiration attributes for entries in this region.
| int gemfire::RegionAttributes::getEntryTimeToLive | ( | ) |
Gets the timeToLive expiration attributes for entries in this region.
| int gemfire::RegionAttributes::getInitialCapacity | ( | ) | const |
Returns the initial capacity of the entry's local cache.
| bool gemfire::RegionAttributes::getInterestListEnabled | ( | ) | const |
This functionality is unsupported in the Native Client Product.
| float gemfire::RegionAttributes::getLoadFactor | ( | ) | const |
Returns the load factor of the entry's local cache.
| uint32_t gemfire::RegionAttributes::getLruEntriesLimit | ( | ) | const |
Returns the maximum number of entries this cache will hold before using LRU eviction.
A return value of zero, 0, indicates no limit.
| const ExpirationAction::Action gemfire::RegionAttributes::getLruEvictionAction | ( | ) | const |
Returns the ExpirationAction used for LRU Eviction, default is LOCAL_DESTROY.
| uint32_t gemfire::RegionAttributes::getMaxValueDistLimit | ( | ) | const |
This functionality is unsupported in the Native Client Product.
| bool gemfire::RegionAttributes::getMirroring | ( | ) | const |
Returns the type of mirroring for this region.
This functionality is unsupported in the Native Client Product.
| const char* gemfire::RegionAttributes::getPersistenceFactory | ( | ) |
This method returns the symbol name of the factory function from which the persistence will be created on a cache server.
| const char* gemfire::RegionAttributes::getPersistenceLibrary | ( | ) |
This method returns the path of the library from which the factory function will be invoked on a cache server.
| PersistenceManagerPtr gemfire::RegionAttributes::getPersistenceManager | ( | ) |
Gets the persistence for the region.
PersistenceManager , null if there is no PersistenceManager for this region. | PropertiesPtr gemfire::RegionAttributes::getPersistenceProperties | ( | ) |
This method returns the properties pointer which is set for persistence.
| int gemfire::RegionAttributes::getRegionIdleTimeout | ( | ) |
Gets the idleTimeout expiration attributes for the region as a whole.
| int gemfire::RegionAttributes::getRegionTimeToLive | ( | ) |
Gets the timeToLive expiration attributes for the region as a whole.
| ScopeType::Scope gemfire::RegionAttributes::getScope | ( | ) | const |
| virtual uint32_t gemfire::RegionAttributes::objectSize | ( | ) | const [inline, virtual] |
return the size in bytes of the instance being serialized. This is used to determine whether the cache is using up more physical memory than it has been configured to use. The method can return zero if the user does not require the ability to control cache memory utilization.
Implements gemfire::Serializable.
| bool gemfire::RegionAttributes::operator!= | ( | const RegionAttributes & | other | ) | const |
Return true if any of the attributes are not equal to those of other.
| bool gemfire::RegionAttributes::operator== | ( | const RegionAttributes & | other | ) | const |
Return true if all the attributes are equal to those of other.
| void gemfire::SharedBase::preserveSB | ( | ) | const [inherited] |
Atomically increment reference count.
| int32_t gemfire::SharedBase::refCount | ( | ) | [inline, inherited] |
| static void gemfire::Serializable::registerType | ( | TypeFactoryMethod | creationFunction | ) | [static, inherited] |
register an instance factory method for a given type. During registration the factory will be invoked to extract the typeId to associate with this function.
| IllegalStateException | if the typeId has already been registered, or there is an error in registering the type; check errno for more information in the latter case. |
| void gemfire::SharedBase::releaseSB | ( | ) | const [inherited] |
Atomically decrement reference count, the SharedBase object is automatically deleted when its reference count goes to zero.
| virtual void gemfire::RegionAttributes::toData | ( | DataOutput & | out | ) | const [virtual] |
| virtual CacheableStringPtr gemfire::Serializable::toString | ( | ) | const [virtual, inherited] |
Display this object as 'string', which depends on the implementation in the subclasses.
The default implementation renders the classname.
The return value may be a temporary, so the caller has to ensure that the SharedPtr count does not go down to zero by storing the result in a variable or otherwise.
Reimplemented in gemfire::CacheableKeyType< TObj, TYPEID, TYPENAME, SPRINTFSYM, STRSIZE >, gemfire::CacheableDate, and gemfire::CacheableString.
| virtual int8_t gemfire::RegionAttributes::typeId | ( | ) | const [virtual] |
| void gemfire::RegionAttributes::validateSerializableAttributes | ( | ) |
throws IllegalStateException if the attributes are not suited for serialization such as those that have a cache callback (listener, loader, or writer) set directly instead of through the string value setters.