Apache Geode Native C++ Reference  1.14.0
apache::geode::client::RegionService Class Referenceabstract

A RegionService provides access to existing regions that exist in a Geode cache. More...

Inherited by apache::geode::client::AuthenticatedView, and apache::geode::client::GeodeCache.

Public Member Functions

virtual void close ()=0
 Terminates this object cache and releases all the local resources. More...
 
virtual PdxInstanceFactory createPdxInstanceFactory (const std::string &className) const =0
 Returns a factory that can create a PdxInstance. More...
 
virtual PdxInstanceFactory createPdxInstanceFactory (const std::string &className, bool expectDomainClass) const =0
 Returns a factory that can create a PdxInstance. More...
 
virtual std::shared_ptr< QueryServicegetQueryService ()=0
 Gets the QueryService from which a new Query can be obtained. More...
 
virtual std::shared_ptr< RegiongetRegion (const std::string &name) const =0
 Look up a region with the name. More...
 
virtual bool isClosed () const =0
 public methods More...
 
virtual std::vector< std::shared_ptr< Region > > rootRegions () const =0
 Returns a set of root regions in the cache. More...
 

Detailed Description

A RegionService provides access to existing regions that exist in a Geode cache.

Regions can be obtained using getRegion and queried using getQueryService. The service should be closed to free up resources once it is no longer needed. Once it is closed any attempt to use it or any {regions} obtained from it will cause a CacheClosedException} to be thrown. Instances of the interface are created using one of the following methods:

Member Function Documentation

◆ close()

virtual void apache::geode::client::RegionService::close ( )
pure virtual

Terminates this object cache and releases all the local resources.

After this cache is closed, any further method call on this cache or any region object will throw CacheClosedException, unless otherwise noted. If RegionService is created from Cache#createAuthenticatedView", then it clears user related security data.

Parameters
keepalivewhether to keep a durable CQ kept alive for this user.
Exceptions
CacheClosedException,ifthe cache is already closed.

Implemented in apache::geode::client::Cache, and apache::geode::client::AuthenticatedView.

◆ createPdxInstanceFactory() [1/2]

virtual PdxInstanceFactory apache::geode::client::RegionService::createPdxInstanceFactory ( const std::string &  className) const
pure virtual

Returns a factory that can create a PdxInstance.

Parameters
classNamethe fully qualified class name that the PdxInstance will become when it is fully deserialized.
Returns
the factory

Implemented in apache::geode::client::Cache, and apache::geode::client::AuthenticatedView.

◆ createPdxInstanceFactory() [2/2]

virtual PdxInstanceFactory apache::geode::client::RegionService::createPdxInstanceFactory ( const std::string &  className,
bool  expectDomainClass 
) const
pure virtual

Returns a factory that can create a PdxInstance.

Parameters
classNamethe fully qualified class name that the PdxInstance will become when it is fully deserialized.
expectDomainClassWhether or not created PdxType represents a Java domain class.
Exceptions
IllegalStateExceptionif the className is nullptr or invalid.
Returns
the factory

Implemented in apache::geode::client::Cache, and apache::geode::client::AuthenticatedView.

◆ getQueryService()

virtual std::shared_ptr<QueryService> apache::geode::client::RegionService::getQueryService ( )
pure virtual

Gets the QueryService from which a new Query can be obtained.

Returns
A smart pointer to the QueryService.

Implemented in apache::geode::client::Cache, and apache::geode::client::AuthenticatedView.

◆ getRegion()

virtual std::shared_ptr<Region> apache::geode::client::RegionService::getRegion ( const std::string &  name) const
pure virtual

Look up a region with the name.

Parameters
namethe region's name, such as root.
Returns
region, or nullptr if no such region exists.

Implemented in apache::geode::client::Cache, and apache::geode::client::AuthenticatedView.

◆ isClosed()

virtual bool apache::geode::client::RegionService::isClosed ( ) const
pure virtual

public methods

Indicates if this cache has been closed. After a new cache object is created, this method returns false; After the close is called on this cache object, this method returns true.

Returns
true, if this cache is closed; false, otherwise

Implemented in apache::geode::client::Cache, and apache::geode::client::AuthenticatedView.

◆ rootRegions()

virtual std::vector<std::shared_ptr<Region> > apache::geode::client::RegionService::rootRegions ( ) const
pure virtual

Returns a set of root regions in the cache.

This set is a snapshot and is not backed by the Cache. The vector passed in is cleared and the regions are added to it.

Implemented in apache::geode::client::Cache, and apache::geode::client::AuthenticatedView.


Apache Geode C++ Cache API Documentation