Files
rippled/src/ripple/shamap/Family.h
Miguel Portilla 86e8f2e232 Add Shard Family
2020-06-30 08:52:18 -07:00

91 lines
2.6 KiB
C++

//------------------------------------------------------------------------------
/*
This file is part of rippled: https://github.com/ripple/rippled
Copyright (c) 2015 Ripple Labs Inc.
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================
#ifndef RIPPLE_SHAMAP_FAMILY_H_INCLUDED
#define RIPPLE_SHAMAP_FAMILY_H_INCLUDED
#include <ripple/basics/Log.h>
#include <ripple/beast/utility/Journal.h>
#include <ripple/nodestore/Database.h>
#include <ripple/shamap/FullBelowCache.h>
#include <ripple/shamap/TreeNodeCache.h>
#include <cstdint>
namespace ripple {
class Family
{
public:
Family(Family const&) = delete;
Family(Family&&) = delete;
Family&
operator=(Family const&) = delete;
Family&
operator=(Family&&) = delete;
explicit Family() = default;
virtual ~Family() = default;
virtual NodeStore::Database&
db() = 0;
virtual NodeStore::Database const&
db() const = 0;
virtual beast::Journal const&
journal() = 0;
/** Return a pointer to the Family Full Below Cache
@param ledgerSeq ledger sequence determines a corresponding shard cache
@note ledgerSeq is used by ShardFamily and ignored by NodeFamily
*/
virtual std::shared_ptr<FullBelowCache>
getFullBelowCache(std::uint32_t ledgerSeq) = 0;
/** Return a pointer to the Family Tree Node Cache
@param ledgerSeq ledger sequence determines a corresponding shard cache
@note ledgerSeq is used by ShardFamily and ignored by NodeFamily
*/
virtual std::shared_ptr<TreeNodeCache>
getTreeNodeCache(std::uint32_t ledgerSeq) = 0;
virtual void
sweep() = 0;
virtual bool
isShardBacked() const = 0;
virtual void
missingNode(std::uint32_t refNum) = 0;
virtual void
missingNode(uint256 const& refHash, std::uint32_t refNum) = 0;
virtual void
reset() = 0;
};
} // namespace ripple
#endif