524b10bd6e
Summary: Ran a spell check over the comments in the include/rocksdb directory and fixed any mis-spellings. There are still some variable names that are spelled incorrectly (like SizeApproximationOptions::include_memtabtles, SstFileMetaData::oldest_ancester_time) that were not fixed, as those would break compilation. Pull Request resolved: https://github.com/facebook/rocksdb/pull/8120 Reviewed By: zhichao-cao Differential Revision: D27366034 Pulled By: mrambacher fbshipit-source-id: 6a3f3674890bb6acc751e9c5887a8fbb6adca5df
49 lines
1.7 KiB
C++
49 lines
1.7 KiB
C++
// Copyright (c) 2011-present, Facebook, Inc. All rights reserved.
|
|
// This source code is licensed under both the GPLv2 (found in the
|
|
// COPYING file in the root directory) and Apache 2.0 License
|
|
// (found in the LICENSE.Apache file in the root directory).
|
|
|
|
#pragma once
|
|
|
|
#include "rocksdb/env.h"
|
|
|
|
namespace ROCKSDB_NAMESPACE {
|
|
|
|
// Allow custom implementations of TraceWriter and TraceReader.
|
|
// By default, RocksDB provides a way to capture the traces to a file using the
|
|
// factory NewFileTraceWriter(). But users could also choose to export traces to
|
|
// any other system by providing custom implementations of TraceWriter and
|
|
// TraceReader.
|
|
|
|
// TraceWriter allows exporting RocksDB traces to any system, one operation at
|
|
// a time.
|
|
class TraceWriter {
|
|
public:
|
|
TraceWriter() {}
|
|
virtual ~TraceWriter() {}
|
|
|
|
virtual Status Write(const Slice& data) = 0;
|
|
virtual Status Close() = 0;
|
|
virtual uint64_t GetFileSize() = 0;
|
|
};
|
|
|
|
// TraceReader allows reading RocksDB traces from any system, one operation at
|
|
// a time. A RocksDB Replayer could depend on this to replay operations.
|
|
class TraceReader {
|
|
public:
|
|
TraceReader() {}
|
|
virtual ~TraceReader() {}
|
|
|
|
virtual Status Read(std::string* data) = 0;
|
|
virtual Status Close() = 0;
|
|
};
|
|
|
|
// Factory methods to read/write traces from/to a file.
|
|
Status NewFileTraceWriter(Env* env, const EnvOptions& env_options,
|
|
const std::string& trace_filename,
|
|
std::unique_ptr<TraceWriter>* trace_writer);
|
|
Status NewFileTraceReader(Env* env, const EnvOptions& env_options,
|
|
const std::string& trace_filename,
|
|
std::unique_ptr<TraceReader>* trace_reader);
|
|
} // namespace ROCKSDB_NAMESPACE
|