apache::geode::client::RegionAttributes Class Reference

Defines attributes for configuring a region. More...

#include <RegionAttributes.hpp>

Inherits internal::DataSerializableInternal.

Public Member Functions
std::shared_ptr< CacheListener >	getCacheListener () const
	Gets the cache listener for the region.
const std::string &	getCacheListenerFactory () const
	This method returns the symbol name of the factory function from which the loader will be created on a cache server.
const std::string &	getCacheListenerLibrary () const
	This method returns the path of the library from which the factory function will be invoked on a cache server.
std::shared_ptr< CacheLoader >	getCacheLoader () const
	public static methods
const std::string &	getCacheLoaderFactory () const
	This method returns the symbol name of the factory function from which the loader will be created on a cache server.
const std::string &	getCacheLoaderLibrary () const
	This method returns the path of the library from which the factory function will be invoked on a cache server.
std::shared_ptr< CacheWriter >	getCacheWriter () const
	Gets the cache writer for the region.
const std::string &	getCacheWriterFactory () const
	This method returns the symbol name of the factory function from which the loader will be created on a cache server.
const std::string &	getCacheWriterLibrary () const
	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.
bool	getConcurrencyChecksEnabled () const
	Returns true if concurrent update checks are turned on for this region.
uint8_t	getConcurrencyLevel () const
	Returns the concurrencyLevel of the entry's local cache.
DiskPolicyType	getDiskPolicy () const
	Returns the disk policy type of the region.
const std::string &	getEndpoints () const
	This method returns the list of servername:portno separated by comma.
std::chrono::seconds	getEntryIdleTimeout () const
	Gets the idleTimeout expiration attributes for entries in this region.
std::chrono::seconds	getEntryTimeToLive () const
	Gets the timeToLive expiration attributes for entries in this region.
int	getInitialCapacity () const
	Returns the initial capacity of the entry's local cache.
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.
ExpirationAction	getLruEvictionAction () const
	Returns the ExpirationAction used for LRU Eviction, default is LOCAL_DESTROY.
std::shared_ptr< PartitionResolver >	getPartitionResolver () const
	Gets the partition resolver for the partition region.
const std::string &	getPartitionResolverFactory () const
	This method returns the symbol name of the factory function from which the loader will be created on a cache server.
const std::string &	getPartitionResolverLibrary () const
	This method returns the path of the library from which the factory function will be invoked on a cache server.
const std::string &	getPersistenceFactory () const
	This method returns the symbol name of the factory function from which the persistence will be created on a cache server.
const std::string &	getPersistenceLibrary () const
	This method returns the path of the library from which the factory function will be invoked on a cache server.
std::shared_ptr< PersistenceManager >	getPersistenceManager () const
	Gets the persistence for the region.
std::shared_ptr< Properties >	getPersistenceProperties () const
	This method returns the properties pointer which is set for persistence.
const std::string &	getPoolName () const
	Returns the name of the pool attached to the region.
std::chrono::seconds	getRegionIdleTimeout () const
	Gets the idleTimeout expiration attributes for the region as a whole.
std::chrono::seconds	getRegionTimeToLive () const
	Gets the timeToLive expiration attributes for the region as a whole.
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	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
static std::shared_ptr< Serializable >	createDeserializable ()
	Return an empty instance for deserialization.

Detailed Description

Defines attributes for configuring a region.

These are CacheListener, CacheLoader, CacheWriter, scope 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 RegionAttributesFactory::create.

For compatibility rules and default values, see RegionAttributesFactory.

Note that the RegionAttributes are not distributed with the region.

See also

RegionAttributesFactory

AttributesMutator

Region::getAttributes

Member Function Documentation

createDeserializable()

static std::shared_ptr< Serializable > apache::geode::client::RegionAttributes::createDeserializable ( )

static

Return an empty instance for deserialization.

getCacheListener()

std::shared_ptr< CacheListener > apache::geode::client::RegionAttributes::getCacheListener

(

)

const

Gets the cache listener for the region.

Returns

a pointer that points to the region's , CacheListener , nullptr if there is no CacheListener defined for this region.

getCacheListenerFactory()

const std::string & apache::geode::client::RegionAttributes::getCacheListenerFactory

(

)

const

This method returns the symbol name of the factory function from which the loader will be created on a cache server.

getCacheListenerLibrary()

const std::string & apache::geode::client::RegionAttributes::getCacheListenerLibrary

(

)

const

This method returns the path of the library from which the factory function will be invoked on a cache server.

getCacheLoader()

std::shared_ptr< CacheLoader > apache::geode::client::RegionAttributes::getCacheLoader

(

)

const

public static methods

Gets the cache loader for the region.

Returns

a pointer that points to the region's , CacheLoader , nullptr if there is no CacheLoader for this region.

getCacheLoaderFactory()

const std::string & apache::geode::client::RegionAttributes::getCacheLoaderFactory

(

)

const

This method returns the symbol name of the factory function from which the loader will be created on a cache server.

getCacheLoaderLibrary()

const std::string & apache::geode::client::RegionAttributes::getCacheLoaderLibrary

(

)

const

This method returns the path of the library from which the factory function will be invoked on a cache server.

getCacheWriter()

std::shared_ptr< CacheWriter > apache::geode::client::RegionAttributes::getCacheWriter

(

)

const

Gets the cache writer for the region.

Returns

a pointer that points to the region's , CacheWriter , nullptr if there is no CacheWriter for this region

getCacheWriterFactory()

const std::string & apache::geode::client::RegionAttributes::getCacheWriterFactory

(

)

const

This method returns the symbol name of the factory function from which the loader will be created on a cache server.

getCacheWriterLibrary()

const std::string & apache::geode::client::RegionAttributes::getCacheWriterLibrary

(

)

const

This method returns the path of the library from which the factory function will be invoked on a cache server.

getCachingEnabled()

bool apache::geode::client::RegionAttributes::getCachingEnabled ( ) const

inline

If true, this region will store data in the current process.

Returns

true or false, indicating cachingEnabled state.

getClientNotificationEnabled()

bool apache::geode::client::RegionAttributes::getClientNotificationEnabled

(

)

const

This method returns the setting of client notification.

getConcurrencyChecksEnabled()

bool apache::geode::client::RegionAttributes::getConcurrencyChecksEnabled ( ) const

inline

Returns true if concurrent update checks are turned on for this region.

Returns

true if concurrent update checks are turned on

getConcurrencyLevel()

uint8_t apache::geode::client::RegionAttributes::getConcurrencyLevel

(

)

const

Returns the concurrencyLevel of the entry's local cache.

Returns

the concurrencyLevel

See also

RegionAttributesFactory

getDiskPolicy()

DiskPolicyType apache::geode::client::RegionAttributes::getDiskPolicy

(

)

const

Returns the disk policy type of the region.

Returns

the DiskPolicyType, default is DiskPolicyType::NONE.

getEndpoints()

const std::string & apache::geode::client::RegionAttributes::getEndpoints

(

)

const

This method returns the list of servername:portno separated by comma.

getEntryIdleTimeout()

std::chrono::seconds apache::geode::client::RegionAttributes::getEntryIdleTimeout

(

)

const

Gets the idleTimeout expiration attributes for entries in this region.

Returns

the idleTimeout expiration attributes for entries in this region

getEntryTimeToLive()

std::chrono::seconds apache::geode::client::RegionAttributes::getEntryTimeToLive

(

)

const

Gets the timeToLive expiration attributes for entries in this region.

Returns

the timeToLive expiration attributes for entries in this region

getInitialCapacity()

int apache::geode::client::RegionAttributes::getInitialCapacity

(

)

const

Returns the initial capacity of the entry's local cache.

Returns

the initial capacity of the entry's local cache

getLoadFactor()

float apache::geode::client::RegionAttributes::getLoadFactor

(

)

const

Returns the load factor of the entry's local cache.

Returns

the load factor of the entry's local cache

getLruEntriesLimit()

uint32_t apache::geode::client::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.

getLruEvictionAction()

ExpirationAction apache::geode::client::RegionAttributes::getLruEvictionAction

(

)

const

Returns the ExpirationAction used for LRU Eviction, default is LOCAL_DESTROY.

getPartitionResolver()

std::shared_ptr< PartitionResolver > apache::geode::client::RegionAttributes::getPartitionResolver

(

)

const

Gets the partition resolver for the partition region.

Returns

a pointer that points to the region's , PartitionResolver , nullptr if there is no PartitionResolver defined for this region.

getPartitionResolverFactory()

const std::string & apache::geode::client::RegionAttributes::getPartitionResolverFactory

(

)

const

This method returns the symbol name of the factory function from which the loader will be created on a cache server.

getPartitionResolverLibrary()

const std::string & apache::geode::client::RegionAttributes::getPartitionResolverLibrary

(

)

const

This method returns the path of the library from which the factory function will be invoked on a cache server.

getPersistenceFactory()

const std::string & apache::geode::client::RegionAttributes::getPersistenceFactory

(

)

const

This method returns the symbol name of the factory function from which the persistence will be created on a cache server.

getPersistenceLibrary()

const std::string & apache::geode::client::RegionAttributes::getPersistenceLibrary

(

)

const

This method returns the path of the library from which the factory function will be invoked on a cache server.

getPersistenceManager()

std::shared_ptr< PersistenceManager > apache::geode::client::RegionAttributes::getPersistenceManager

(

)

const

Gets the persistence for the region.

Returns

a pointer that points to the region's , PersistenceManager , nullptr if there is no PersistenceManager for this region.

getPersistenceProperties()

std::shared_ptr< Properties > apache::geode::client::RegionAttributes::getPersistenceProperties

(

)

const

This method returns the properties pointer which is set for persistence.

getPoolName()

const std::string & apache::geode::client::RegionAttributes::getPoolName ( ) const

inline

Returns the name of the pool attached to the region.

getRegionIdleTimeout()

std::chrono::seconds apache::geode::client::RegionAttributes::getRegionIdleTimeout

(

)

const

Gets the idleTimeout expiration attributes for the region as a whole.

Returns

the IdleTimeout expiration attributes for this region

getRegionTimeToLive()

std::chrono::seconds apache::geode::client::RegionAttributes::getRegionTimeToLive

(

)

const

Gets the timeToLive expiration attributes for the region as a whole.

Returns

the timeToLive expiration attributes for this region

operator!=()

bool apache::geode::client::RegionAttributes::operator!=

(

const RegionAttributes &

other

)

const

Return true if any of the attributes are not equal to those of other.

operator==()

bool apache::geode::client::RegionAttributes::operator==

(

const RegionAttributes &

other

)

const

Return true if all the attributes are equal to those of other.

validateSerializableAttributes()

void apache::geode::client::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.