vmware-gemfire-native-client-c++-api-reference/10.4/a00182_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_PERSISTENCEMANAGER_H_

#define GEODE_PERSISTENCEMANAGER_H_


#include <memory>


#include "Serializable.hpp"

#include "internal/geode_globals.hpp"


namespace apache {

namespace geode {

namespace client {


class CacheableKey;

class Properties;

class PersistenceManager;

class Region;


typedef std::shared_ptr<PersistenceManager> (*getPersistenceManagerInstance)(

    const std::shared_ptr<Region>&);


class APACHE_GEODE_EXPORT PersistenceManager {

 public:

  static std::shared_ptr<PersistenceManager> getPersistenceManager();


  virtual void write(const std::shared_ptr<CacheableKey>& key,

                     const std::shared_ptr<Cacheable>& value,

                     std::shared_ptr<void>& persistenceInfo) = 0;


  virtual bool writeAll() = 0;


  virtual void init(const std::shared_ptr<Region>& region,

                    const std::shared_ptr<Properties>& diskProperties) = 0;


  virtual std::shared_ptr<Cacheable> read(

      const std::shared_ptr<CacheableKey>& key,

      const std::shared_ptr<void>& PersistenceInfo) = 0;


  virtual bool readAll() = 0;


  virtual void destroy(const std::shared_ptr<CacheableKey>& key,

                       const std::shared_ptr<void>& PersistenceInfo) = 0;


  virtual void close() = 0;


  explicit PersistenceManager(const std::shared_ptr<Region>& regionPtr)

      : m_regionPtr(regionPtr) {}


  PersistenceManager() = default;


  virtual ~PersistenceManager() = default;


 protected:

  std::shared_ptr<Region> m_regionPtr;

};

}  // namespace client

}  // namespace geode

}  // namespace apache


#endif  // GEODE_PERSISTENCEMANAGER_H_

apache::geode::client::PersistenceManager
PersistenceManager API for persistence and overflow.
Definition PersistenceManager.hpp:52

apache::geode::client::PersistenceManager::readAll
virtual bool readAll()=0
Reads all the values from the region.

apache::geode::client::PersistenceManager::getPersistenceManager
static std::shared_ptr< PersistenceManager > getPersistenceManager()
Returns the current persistence manager.

apache::geode::client::PersistenceManager::m_regionPtr
std::shared_ptr< Region > m_regionPtr
Region for this persistence manager.
Definition PersistenceManager.hpp:135

apache::geode::client::PersistenceManager::init
virtual void init(const std::shared_ptr< Region > &region, const std::shared_ptr< Properties > &diskProperties)=0
This method gets called after an implementation object is created.

apache::geode::client::PersistenceManager::write
virtual void write(const std::shared_ptr< CacheableKey > &key, const std::shared_ptr< Cacheable > &value, std::shared_ptr< void > &persistenceInfo)=0
Writes a key, value pair of region to the disk.

apache::geode::client::PersistenceManager::close
virtual void close()=0
Closes the persistence manager instance.

apache::geode::client::PersistenceManager::destroy
virtual void destroy(const std::shared_ptr< CacheableKey > &key, const std::shared_ptr< void > &PersistenceInfo)=0
destroys the entry specified by the key in the argument.

apache::geode::client::PersistenceManager::read
virtual std::shared_ptr< Cacheable > read(const std::shared_ptr< CacheableKey > &key, const std::shared_ptr< void > &PersistenceInfo)=0
Reads the value for the key from the disk.

apache::geode::client::PersistenceManager::writeAll
virtual bool writeAll()=0
Writes all the entries for a region.