1
0
Fork 0
arangodb/arangod/RocksDBEngine/RocksDBReplicationManager.h

113 lines
4.2 KiB
C++

////////////////////////////////////////////////////////////////////////////////
/// DISCLAIMER
///
/// Copyright 2017 ArangoDB GmbH, Cologne, Germany
///
/// Licensed 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.
///
/// Copyright holder is ArangoDB GmbH, Cologne, Germany
///
/// @author Simon Grätzer
////////////////////////////////////////////////////////////////////////////////
#ifndef ARANGO_ROCKSDB_ROCKSDB_REPLICATION_MANAGER_H
#define ARANGO_ROCKSDB_ROCKSDB_REPLICATION_MANAGER_H 1
#include "Basics/Common.h"
#include "Basics/Mutex.h"
struct TRI_vocbase_t;
namespace arangodb {
class RocksDBReplicationContext;
typedef uint64_t RocksDBReplicationId;
class RocksDBReplicationManager {
public:
//////////////////////////////////////////////////////////////////////////////
/// @brief create a cursors repository
//////////////////////////////////////////////////////////////////////////////
explicit RocksDBReplicationManager();
//////////////////////////////////////////////////////////////////////////////
/// @brief destroy a cursors repository
//////////////////////////////////////////////////////////////////////////////
~RocksDBReplicationManager();
public:
////////////////////////////////////////////////////////////////////////////////
/// @brief stores a cursor in the registry
/// the repository will take ownership of the cursor
////////////////////////////////////////////////////////////////////////////////
RocksDBReplicationContext* addCursor(std::unique_ptr<RocksDBReplicationContext> cursor);
//////////////////////////////////////////////////////////////////////////////
/// @brief remove a cursor by id
//////////////////////////////////////////////////////////////////////////////
bool remove(RocksDBReplicationId);
//////////////////////////////////////////////////////////////////////////////
/// @brief find an existing cursor by id
/// if found, the cursor will be returned with the usage flag set to true.
/// it must be returned later using release()
//////////////////////////////////////////////////////////////////////////////
RocksDBReplicationContext* find(RocksDBReplicationId, bool&);
//////////////////////////////////////////////////////////////////////////////
/// @brief return a cursor
//////////////////////////////////////////////////////////////////////////////
void release(RocksDBReplicationContext*);
//////////////////////////////////////////////////////////////////////////////
/// @brief whether or not the repository contains a used cursor
//////////////////////////////////////////////////////////////////////////////
bool containsUsedCursor();
//////////////////////////////////////////////////////////////////////////////
/// @brief run a garbage collection on the cursors
//////////////////////////////////////////////////////////////////////////////
bool garbageCollect(bool);
private:
//////////////////////////////////////////////////////////////////////////////
/// @brief mutex for the cursors repository
//////////////////////////////////////////////////////////////////////////////
Mutex _lock;
//////////////////////////////////////////////////////////////////////////////
/// @brief list of current cursors
//////////////////////////////////////////////////////////////////////////////
std::unordered_map<RocksDBReplicationId, RocksDBReplicationContext*> _contexts;
//////////////////////////////////////////////////////////////////////////////
/// @brief maximum number of cursors to garbage-collect in one go
//////////////////////////////////////////////////////////////////////////////
static size_t const MaxCollectCount;
};
}
#endif