2023-08-05 20:13:43 +00:00
|
|
|
/*
|
|
|
|
* LMDB Abstraction Layer.
|
|
|
|
* Copyright (C) 2023 Yury Gubich <blue@macaw.me>
|
|
|
|
*
|
|
|
|
* 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 3 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, see <http://www.gnu.org/licenses/>.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef LMDBAL_CURSOR_H
|
|
|
|
#define LMDBAL_CURSOR_H
|
|
|
|
|
2023-08-07 21:27:44 +00:00
|
|
|
#include <string>
|
|
|
|
|
|
|
|
#include "lmdb.h"
|
2023-08-05 20:13:43 +00:00
|
|
|
#include "base.h"
|
|
|
|
#include "storage.h"
|
2023-10-17 21:06:11 +00:00
|
|
|
#include "transaction.h"
|
2023-08-05 20:13:43 +00:00
|
|
|
|
|
|
|
namespace LMDBAL {
|
|
|
|
|
|
|
|
template <class K, class V>
|
|
|
|
class Cursor {
|
|
|
|
friend class Storage<K, V>;
|
|
|
|
private:
|
2023-08-07 21:27:44 +00:00
|
|
|
enum State { /**<Cursor state:*/
|
|
|
|
closed, /**< - closed*/
|
|
|
|
openedPublic, /**< - opened with public transaction, all storages will be notified about it after it's done*/
|
|
|
|
openedPrivate /**< - opened with private transaction, only current storage will be notified when cursor is closed*/
|
|
|
|
};
|
|
|
|
|
2023-10-25 22:18:23 +00:00
|
|
|
public:
|
|
|
|
Cursor();
|
2023-08-05 20:13:43 +00:00
|
|
|
Cursor(Storage<K, V>* parent);
|
2023-10-25 22:18:23 +00:00
|
|
|
Cursor(const Cursor& other) = delete;
|
|
|
|
Cursor(Cursor&& other);
|
2023-08-05 20:13:43 +00:00
|
|
|
~Cursor();
|
|
|
|
|
2023-10-25 22:18:23 +00:00
|
|
|
Cursor& operator = (const Cursor& other) = delete;
|
|
|
|
Cursor& operator = (Cursor&& other);
|
|
|
|
|
|
|
|
void open();
|
|
|
|
void open(const Transaction& transaction);
|
|
|
|
void renew();
|
|
|
|
void renew(const Transaction& transaction);
|
|
|
|
void close();
|
2023-08-10 23:07:12 +00:00
|
|
|
bool opened() const;
|
2023-10-25 22:18:23 +00:00
|
|
|
bool empty() const;
|
|
|
|
|
|
|
|
void drop();
|
2023-08-07 21:27:44 +00:00
|
|
|
|
2023-10-25 22:18:23 +00:00
|
|
|
std::pair<K, V> first();
|
|
|
|
std::pair<K, V> last();
|
|
|
|
std::pair<K, V> next();
|
|
|
|
std::pair<K, V> prev();
|
2023-08-07 21:27:44 +00:00
|
|
|
std::pair<K, V> current() const;
|
2023-10-25 22:18:23 +00:00
|
|
|
bool set(const K& target);
|
2023-08-07 21:27:44 +00:00
|
|
|
|
2023-10-25 22:18:23 +00:00
|
|
|
void first(K& key, V& value);
|
|
|
|
void last(K& key, V& value);
|
|
|
|
void next(K& key, V& value);
|
|
|
|
void prev(K& key, V& value);
|
2023-08-09 17:41:15 +00:00
|
|
|
void current(K& key, V& value) const;
|
2023-08-05 20:13:43 +00:00
|
|
|
|
|
|
|
private:
|
2023-10-25 22:18:23 +00:00
|
|
|
void dropped();
|
2023-11-01 22:45:42 +00:00
|
|
|
void freed();
|
2023-10-25 22:18:23 +00:00
|
|
|
void terminated();
|
2023-08-09 17:41:15 +00:00
|
|
|
void operateCursorRead(K& key, V& value, MDB_cursor_op operation, const std::string& methodName, const std::string& operationName) const;
|
2023-08-05 20:13:43 +00:00
|
|
|
|
|
|
|
private:
|
|
|
|
Storage<K, V>* storage;
|
2023-10-25 22:18:23 +00:00
|
|
|
MDB_cursor* cursor;
|
|
|
|
State state;
|
|
|
|
uint32_t id;
|
2023-08-07 21:27:44 +00:00
|
|
|
|
2023-08-09 17:41:15 +00:00
|
|
|
inline static const std::string openCursorMethodName = "Cursor::open"; /**<\brief member function name, just for exceptions*/
|
|
|
|
inline static const std::string closeCursorMethodName = "Cursor::close"; /**<\brief member function name, just for exceptions*/
|
|
|
|
inline static const std::string renewCursorMethodName = "Cursor::renew"; /**<\brief member function name, just for exceptions*/
|
|
|
|
|
|
|
|
inline static const std::string firstMethodName = "first"; /**<\brief member function name, just for exceptions*/
|
|
|
|
inline static const std::string lastMethodName = "last"; /**<\brief member function name, just for exceptions*/
|
|
|
|
inline static const std::string nextMethodName = "next"; /**<\brief member function name, just for exceptions*/
|
|
|
|
inline static const std::string prevMethodName = "prev"; /**<\brief member function name, just for exceptions*/
|
|
|
|
inline static const std::string currentMethodName = "current"; /**<\brief member function name, just for exceptions*/
|
2023-11-01 22:45:42 +00:00
|
|
|
inline static const std::string setMethodName = "set"; /**<\brief member function name, just for exceptions*/
|
2023-08-09 17:41:15 +00:00
|
|
|
|
|
|
|
inline static const std::string firstOperationName = "Cursor::first"; /**<\brief member function name, just for exceptions*/
|
|
|
|
inline static const std::string lastOperationName = "Cursor::last"; /**<\brief member function name, just for exceptions*/
|
|
|
|
inline static const std::string nextOperationName = "Cursor::next"; /**<\brief member function name, just for exceptions*/
|
|
|
|
inline static const std::string prevOperationName = "Cursor::prev"; /**<\brief member function name, just for exceptions*/
|
|
|
|
inline static const std::string currentOperationName = "Cursor::current"; /**<\brief member function name, just for exceptions*/
|
2023-08-05 20:13:43 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
#include "cursor.hpp"
|
|
|
|
|
|
|
|
#endif //LMDBAL_CURSOR_H
|