snapshot_manager.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2014-2015, Hewlett-Packard Development Company, LP.
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation; either version 2 of the License, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 * more details. You should have received a copy of the GNU General Public
 * License along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 * HP designates this particular file as subject to the "Classpath" exception
 * as provided by HP in the LICENSE.txt file that accompanied this code.
 */
#ifndef FOEDUS_SNAPSHOT_SNAPSHOT_MANAGER_HPP_
#define FOEDUS_SNAPSHOT_SNAPSHOT_MANAGER_HPP_
#include "foedus/epoch.hpp"
#include "foedus/fwd.hpp"
#include "foedus/initializable.hpp"
#include "foedus/snapshot/fwd.hpp"
#include "foedus/snapshot/snapshot_id.hpp"
namespace foedus {
namespace snapshot {
class SnapshotManager CXX11_FINAL : public virtual Initializable {
 public:
  explicit SnapshotManager(Engine* engine);
  ~SnapshotManager();

  // Disable default constructors
  SnapshotManager() CXX11_FUNC_DELETE;
  SnapshotManager(const SnapshotManager&) CXX11_FUNC_DELETE;
  SnapshotManager& operator=(const SnapshotManager&) CXX11_FUNC_DELETE;

  ErrorStack  initialize() CXX11_OVERRIDE;
  bool        is_initialized() const CXX11_OVERRIDE;
  ErrorStack  uninitialize() CXX11_OVERRIDE;

  Epoch get_snapshot_epoch() const;
  Epoch get_snapshot_epoch_weak() const;

  SnapshotId get_previous_snapshot_id() const;
  SnapshotId get_previous_snapshot_id_weak() const;

  ErrorStack read_snapshot_metadata(SnapshotId snapshot_id, SnapshotMetadata* out);

  void    trigger_snapshot_immediate(
    bool wait_completion,
    Epoch suggested_snapshot_epoch = INVALID_EPOCH);

  SnapshotManagerPimpl* get_pimpl() { return pimpl_; }

 private:
  SnapshotManagerPimpl *pimpl_;
};
}  // namespace snapshot
}  // namespace foedus
#endif  // FOEDUS_SNAPSHOT_SNAPSHOT_MANAGER_HPP_