mirror of
https://github.com/XRPLF/rippled.git
synced 2025-12-06 17:27:55 +00:00
8be4e7e65f
* Make LessThan private * Make NodeObject::isSame private * Remove hotTRANSACTION * Remove some Serializer members * Remove unused SHAMapItem::getRaw * Remove unused STLedgerEntry::getOwners * Remove Serializer constructors * Remove unused Serializer members * Remove SerialIter ctor
114 lines
3.8 KiB
C++
114 lines
3.8 KiB
C++
//------------------------------------------------------------------------------
|
|
/*
|
|
This file is part of rippled: https://github.com/ripple/rippled
|
|
Copyright (c) 2012, 2013 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_NODESTORE_BACKEND_H_INCLUDED
|
|
#define RIPPLE_NODESTORE_BACKEND_H_INCLUDED
|
|
|
|
#include <ripple/nodestore/Types.h>
|
|
|
|
namespace ripple {
|
|
namespace NodeStore {
|
|
|
|
/** A backend used for the NodeStore.
|
|
|
|
The NodeStore uses a swappable backend so that other database systems
|
|
can be tried. Different databases may offer various features such
|
|
as improved performance, fault tolerant or distributed storage, or
|
|
all in-memory operation.
|
|
|
|
A given instance of a backend is fixed to a particular key size.
|
|
*/
|
|
class Backend
|
|
{
|
|
public:
|
|
/** Destroy the backend.
|
|
|
|
All open files are closed and flushed. If there are batched writes
|
|
or other tasks scheduled, they will be completed before this call
|
|
returns.
|
|
*/
|
|
virtual ~Backend() = default;
|
|
|
|
/** Get the human-readable name of this backend.
|
|
This is used for diagnostic output.
|
|
*/
|
|
virtual std::string getName() = 0;
|
|
|
|
/** Close the backend.
|
|
This allows the caller to catch exceptions.
|
|
*/
|
|
virtual void close() = 0;
|
|
|
|
/** Fetch a single object.
|
|
If the object is not found or an error is encountered, the
|
|
result will indicate the condition.
|
|
@note This will be called concurrently.
|
|
@param key A pointer to the key data.
|
|
@param pObject [out] The created object if successful.
|
|
@return The result of the operation.
|
|
*/
|
|
virtual Status fetch (void const* key, std::shared_ptr<NodeObject>* pObject) = 0;
|
|
|
|
/** Return `true` if batch fetches are optimized. */
|
|
virtual
|
|
bool
|
|
canFetchBatch() = 0;
|
|
|
|
/** Fetch a batch synchronously. */
|
|
virtual
|
|
std::vector<std::shared_ptr<NodeObject>>
|
|
fetchBatch (std::size_t n, void const* const* keys) = 0;
|
|
|
|
/** Store a single object.
|
|
Depending on the implementation this may happen immediately
|
|
or deferred using a scheduled task.
|
|
@note This will be called concurrently.
|
|
@param object The object to store.
|
|
*/
|
|
virtual void store (std::shared_ptr<NodeObject> const& object) = 0;
|
|
|
|
/** Store a group of objects.
|
|
@note This function will not be called concurrently with
|
|
itself or @ref store.
|
|
*/
|
|
virtual void storeBatch (Batch const& batch) = 0;
|
|
|
|
/** Visit every object in the database
|
|
This is usually called during import.
|
|
@note This routine will not be called concurrently with itself
|
|
or other methods.
|
|
@see import
|
|
*/
|
|
virtual void for_each (std::function <void (std::shared_ptr<NodeObject>)> f) = 0;
|
|
|
|
/** Estimate the number of write operations pending. */
|
|
virtual int getWriteLoad () = 0;
|
|
|
|
/** Remove contents on disk upon destruction. */
|
|
virtual void setDeletePath() = 0;
|
|
|
|
/** Perform consistency checks on database .*/
|
|
virtual void verify() = 0;
|
|
};
|
|
|
|
}
|
|
}
|
|
|
|
#endif
|