VMware GemFire Native Client C++ API Reference
|
VMware VMware GemFire Native C++ Reference 10.4.3
|
GeodeCache represents the singleton cache that must be created in order to connect to Geode server. More...
#include <GeodeCache.hpp>
Inherits apache::geode::client::RegionService.
Inherited by apache::geode::client::Cache.
Public Member Functions | |
| virtual void | close ()=0 |
| Terminates this object cache and releases all the local resources. | |
| virtual PdxInstanceFactory | createPdxInstanceFactory (const std::string &className) const =0 |
Returns a factory that can create a PdxInstance. | |
| virtual PdxInstanceFactory | createPdxInstanceFactory (const std::string &className, bool expectDomainClass) const =0 |
Returns a factory that can create a PdxInstance. | |
| virtual const std::string & | getName () const =0 |
| Returns the name of this cache. | |
| virtual bool | getPdxIgnoreUnreadFields () const =0 |
| Returns whether Cache saves unread fields for Pdx types. | |
| virtual bool | getPdxReadSerialized () const =0 |
Returns whether PdxInstance is preferred for PDX types instead of C++ object. | |
| virtual std::shared_ptr< QueryService > | getQueryService ()=0 |
| Gets the QueryService from which a new Query can be obtained. | |
| virtual std::shared_ptr< Region > | getRegion (const std::string &name) const =0 |
| Look up a region with the name. | |
| virtual void | initializeDeclarativeCache (const std::string &cacheXml)=0 |
| Initialize the cache by the contents of an xml file. | |
| virtual bool | isClosed () const =0 |
| Indicates if this cache has been closed. | |
| virtual std::vector< std::shared_ptr< Region > > | rootRegions () const =0 |
| Returns a set of root regions in the cache. | |
Detailed Description
GeodeCache represents the singleton cache that must be created in order to connect to Geode server.
Users must create a Cache. Instances of this interface are created using one of the following methods:
-
ClientCacheFactory#create()creates a client instance ofCache.
Member Function Documentation
◆ close()
|
pure virtualinherited |
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
-
keepalive whether to keep a durable CQ kept alive for this user.
- Exceptions
-
CacheClosedException,if the cache is already closed.
Implemented in apache::geode::client::AuthenticatedView, and apache::geode::client::Cache.
◆ createPdxInstanceFactory() [1/2]
|
pure virtualinherited |
Returns a factory that can create a PdxInstance.
- Parameters
-
className the fully qualified class name that the PdxInstance will become when it is fully deserialized.
- Returns
- the factory
Implemented in apache::geode::client::AuthenticatedView, and apache::geode::client::Cache.
◆ createPdxInstanceFactory() [2/2]
|
pure virtualinherited |
Returns a factory that can create a PdxInstance.
- Parameters
-
className the fully qualified class name that the PdxInstance will become when it is fully deserialized. expectDomainClass Whether or not created PdxType represents a Java domain class.
- Exceptions
-
IllegalStateException if the className is nullptr or invalid.
- Returns
- the factory
Implemented in apache::geode::client::AuthenticatedView, and apache::geode::client::Cache.
◆ getName()
|
pure virtual |
Returns the name of this cache.
- Returns
- the string name of this cache
Implemented in apache::geode::client::Cache.
◆ getPdxIgnoreUnreadFields()
|
pure virtual |
Returns whether Cache saves unread fields for Pdx types.
Implemented in apache::geode::client::Cache.
◆ getPdxReadSerialized()
|
pure virtual |
Returns whether PdxInstance is preferred for PDX types instead of C++ object.
Implemented in apache::geode::client::Cache.
◆ getQueryService()
|
pure virtualinherited |
Gets the QueryService from which a new Query can be obtained.
- Returns
- A smart pointer to the QueryService.
Implemented in apache::geode::client::AuthenticatedView, and apache::geode::client::Cache.
◆ getRegion()
|
pure virtualinherited |
Look up a region with the name.
- Parameters
-
name the region's name, such as root.
- Returns
- region, or nullptr if no such region exists.
Implemented in apache::geode::client::AuthenticatedView, and apache::geode::client::Cache.
◆ initializeDeclarativeCache()
|
pure virtual |
Initialize the cache by the contents of an xml file.
- Parameters
-
cacheXml The xml file
- Exceptions
-
OutOfMemoryException CacheXmlException Something went wrong while parsing the XML IllegalStateException If xml file is well-flrmed but not valid RegionExistsException if a region is already in this cache CacheClosedException if the cache is closed at the time of region creation UnknownException otherwise
Implemented in apache::geode::client::Cache.
◆ isClosed()
|
pure virtualinherited |
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::AuthenticatedView, and apache::geode::client::Cache.
◆ rootRegions()
|
pure virtualinherited |
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::AuthenticatedView, and apache::geode::client::Cache.
Apache Geode C++ Cache API Documentation