VMware GemFire Native Client C++ API Reference
|
VMware VMware GemFire Native C++ Reference 10.4.3
|
Creates an authenticated cache view to allow credential based access to region services. More...
#include <AuthenticatedView.hpp>
Inherits apache::geode::client::RegionService.
Public Member Functions | |
| void | close () override |
| Terminates this object cache and releases all the local resources. | |
| PdxInstanceFactory | createPdxInstanceFactory (const std::string &className) const override |
Returns a factory that can create a PdxInstance. | |
| PdxInstanceFactory | createPdxInstanceFactory (const std::string &className, bool expectDomainClass) const override |
Returns a factory that can create a PdxInstance. | |
| std::shared_ptr< QueryService > | getQueryService () override |
| Gets the QueryService from which a new Query can be obtained. | |
| std::shared_ptr< Region > | getRegion (const std::string &path) const override |
| Look up a region with the full path from root. | |
| bool | isClosed () const override |
| public methods | |
| std::vector< std::shared_ptr< Region > > | rootRegions () const override |
| Returns a set of root regions in the cache. | |
Detailed Description
Creates an authenticated cache view to allow credential based access to region services.
Member Function Documentation
◆ close()
|
overridevirtual |
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.
- Exceptions
-
CacheClosedException,if the cache is already closed.
Implements apache::geode::client::RegionService.
◆ createPdxInstanceFactory() [1/2]
|
overridevirtual |
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
Implements apache::geode::client::RegionService.
◆ createPdxInstanceFactory() [2/2]
|
overridevirtual |
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.
- Returns
- the factory
Implements apache::geode::client::RegionService.
◆ getQueryService()
|
overridevirtual |
Gets the QueryService from which a new Query can be obtained.
- Returns
- A smart pointer to the QueryService.
Implements apache::geode::client::RegionService.
◆ getRegion()
|
overridevirtual |
Look up a region with the full path from root.
- Parameters
-
path the region's path, such as RootA/Sub1/Sub1A.
- Returns
- region, or nullptr if no such region exists.
Implements apache::geode::client::RegionService.
◆ isClosed()
|
overridevirtual |
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
Implements apache::geode::client::RegionService.
◆ rootRegions()
|
overridevirtual |
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.
Implements apache::geode::client::RegionService.
Apache Geode C++ Cache API Documentation