vmware-gemfire-native-client-c++-api-reference/latest/a00023_source.html

/*

 * Licensed to the Apache Software Foundation (ASF) under one or more

 * contributor license agreements.  See the NOTICE file distributed with

 * this work for additional information regarding copyright ownership.

 * The ASF licenses this file to You under the Apache License, Version 2.0

 * (the "License"); you may not use this file except in compliance with

 * the License.  You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */


#pragma once


#ifndef GEODE_CACHE_H_

#define GEODE_CACHE_H_


#include <string>


#include <geode/util/LogLevel.hpp>


#include "GeodeCache.hpp"

#include "internal/geode_globals.hpp"


namespace apache {

namespace geode {

namespace client {


class AuthenticatedView;

class AuthInitialize;

class CacheFactory;

class CacheImpl;

class CacheRegionHelper;

class CacheTransactionManager;

class DataInput;

class DataOutput;

class Pool;

class PoolFactory;

class PoolManager;

class Properties;

class QueryService;

class Region;

class RegionFactory;

class TypeRegistry;

enum class RegionShortcut;


class APACHE_GEODE_EXPORT Cache : public GeodeCache {

 public:

  virtual RegionFactory createRegionFactory(RegionShortcut regionShortcut);


  void initializeDeclarativeCache(const std::string& cacheXml) override;


  const std::string& getName() const override;


  bool isClosed() const override;


  TypeRegistry& getTypeRegistry() const;


  void close() override;


  virtual void close(bool keepalive);


  std::shared_ptr<Region> getRegion(const std::string& path) const override;


  std::vector<std::shared_ptr<Region>> rootRegions() const override;


  std::shared_ptr<QueryService> getQueryService() override;


  virtual std::shared_ptr<QueryService> getQueryService(

      const std::string& poolName) const;


  virtual void readyForEvents();


  virtual AuthenticatedView createAuthenticatedView(

      const std::shared_ptr<Properties>& userSecurityProperties,

      const std::string& poolName);


  virtual std::shared_ptr<CacheTransactionManager> getCacheTransactionManager()

      const;


  bool getPdxIgnoreUnreadFields() const override;


  bool getPdxReadSerialized() const override;


  PdxInstanceFactory createPdxInstanceFactory(

      const std::string& className) const override;


  PdxInstanceFactory createPdxInstanceFactory(

      const std::string& className, bool expectDomainClass) const override;


  virtual DataInput createDataInput(const uint8_t* m_buffer, size_t len) const;


  virtual DataOutput createDataOutput() const;


  virtual PoolManager& getPoolManager() const;


  SystemProperties& getSystemProperties() const override;


  void setLogLevel(LogLevel newLevel);


  LogLevel getLogLevel();


  Cache() = delete;

  ~Cache() override;


  Cache(const Cache& other) = delete;

  Cache& operator=(const Cache& other) = delete;

  Cache(Cache&& other) noexcept;

  Cache& operator=(Cache&& other) noexcept;


 private:

  Cache(const std::shared_ptr<Properties>& dsProp, bool ignorePdxUnreadFields,

        bool readPdxSerialized,

        const std::shared_ptr<AuthInitialize>& authInitialize);


  std::unique_ptr<CacheImpl> m_cacheImpl;


 protected:

  friend class CacheFactory;

  friend class CacheRegionHelper;

  friend class FunctionService;

  friend class CacheXmlCreation;

  friend class RegionXmlCreation;

};


}  // namespace client

}  // namespace geode

}  // namespace apache


#endif  // GEODE_CACHE_H_

apache::geode::client::AuthenticatedView
Creates an authenticated cache view to allow credential based access to region services.
Definition AuthenticatedView.hpp:46

apache::geode::client::Cache
Caches are obtained from the create method on the CacheFactory#create class.
Definition Cache.hpp:65

apache::geode::client::Cache::getCacheTransactionManager
virtual std::shared_ptr< CacheTransactionManager > getCacheTransactionManager() const
Get the CacheTransactionManager instance for this Cache.

apache::geode::client::Cache::rootRegions
std::vector< std::shared_ptr< Region > > rootRegions() const override
Returns a set of root regions in the cache.

apache::geode::client::Cache::createAuthenticatedView
virtual AuthenticatedView createAuthenticatedView(const std::shared_ptr< Properties > &userSecurityProperties, const std::string &poolName)
Creates an authenticated cache using the given user security properties.

apache::geode::client::Cache::getQueryService
std::shared_ptr< QueryService > getQueryService() override
Gets the QueryService from which a new Query can be obtained.

apache::geode::client::Cache::getTypeRegistry
TypeRegistry & getTypeRegistry() const
Returns the type registry that this cache was created with.

apache::geode::client::Cache::close
void close() override
Terminates this object cache and releases all the local resources.

apache::geode::client::Cache::createPdxInstanceFactory
PdxInstanceFactory createPdxInstanceFactory(const std::string &className, bool expectDomainClass) const override
Returns a factory that can create a PdxInstance.

apache::geode::client::Cache::close
virtual void close(bool keepalive)
Terminates this object cache and releases all the local resources.

apache::geode::client::Cache::getLogLevel
LogLevel getLogLevel()
Returns the current log level.

apache::geode::client::Cache::getPdxReadSerialized
bool getPdxReadSerialized() const override
Returns whether PdxInstance is preferred for PDX types instead of C++ object.

apache::geode::client::Cache::isClosed
bool isClosed() const override
Indicates if this cache has been closed.

apache::geode::client::Cache::setLogLevel
void setLogLevel(LogLevel newLevel)
Changes the current log level to newLogLevel.

apache::geode::client::Cache::getRegion
std::shared_ptr< Region > getRegion(const std::string &path) const override
Look up a region with the full path from root.

apache::geode::client::Cache::getPdxIgnoreUnreadFields
bool getPdxIgnoreUnreadFields() const override
Returns whether Cache saves unread fields for Pdx types.

apache::geode::client::Cache::readyForEvents
virtual void readyForEvents()
Send the "client ready" message to the server from a durable client.

apache::geode::client::Cache::createPdxInstanceFactory
PdxInstanceFactory createPdxInstanceFactory(const std::string &className) const override
Returns a factory that can create a PdxInstance.

apache::geode::client::Cache::createRegionFactory
virtual RegionFactory createRegionFactory(RegionShortcut regionShortcut)
Returns the RegionFactory to create the region.

apache::geode::client::Cache::getName
const std::string & getName() const override
Returns the name of this cache.

apache::geode::client::Cache::initializeDeclarativeCache
void initializeDeclarativeCache(const std::string &cacheXml) override
Initializes the cache from an xml file.

apache::geode::client::Cache::getQueryService
virtual std::shared_ptr< QueryService > getQueryService(const std::string &poolName) const
Gets the QueryService from which a new Query can be obtained.

apache::geode::client::CacheFactory
Top level class for configuring and using Geode on a client.This should be called once to create Cach...
Definition CacheFactory.hpp:48

apache::geode::client::DataInput
Provide operations for reading primitive data values, byte arrays, strings, Serializable objects from...
Definition DataInput.hpp:59

apache::geode::client::DataOutput
Provide operations for writing primitive data values, byte arrays, strings, Serializable objects to a...
Definition DataOutput.hpp:48

apache::geode::client::FunctionService
entry point for function execution
Definition FunctionService.hpp:45

apache::geode::client::GeodeCache
GeodeCache represents the singleton cache that must be created in order to connect to Geode server.
Definition GeodeCache.hpp:44

apache::geode::client::PdxInstanceFactory
PdxInstanceFactory gives you a way to create PdxInstances.
Definition PdxInstanceFactory.hpp:52

apache::geode::client::PoolManager
Manages creation and access to connection pools for clients.
Definition PoolManager.hpp:61

apache::geode::client::RegionFactory
Provides for the configuration and creation of instances of Region.
Definition RegionFactory.hpp:43

apache::geode::client::SystemProperties
The SystemProperties class.
Definition SystemProperties.hpp:44

apache::geode::client::TypeRegistry
Registry for custom serializable types, both PDXSerializable and DataSerializable.
Definition TypeRegistry.hpp:39