1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
/*
* Copyright (C) 2014 Christian Mollekopf <chrigi_1@fastmail.fm>
* Copyright (C) 2014 Aaron Seigo <aseigo@kde.org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) version 3, or any
* later version accepted by the membership of KDE e.V. (or its
* successor approved by the membership of KDE e.V.), which shall
* act as a proxy defined in Section 6 of version 3 of the license.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#pragma once
#include <akonadi2common_export.h>
#include <string>
#include <functional>
#include <QString>
namespace Akonadi2
{
class AKONADI2COMMON_EXPORT Storage {
public:
enum AccessMode { ReadOnly, ReadWrite };
enum ErrorCodes {
GenericError,
NotOpen,
ReadOnlyError,
TransactionError,
NotFound
};
class Error
{
public:
Error(const QByteArray &s, int c, const QByteArray &m)
: store(s), message(m), code(c) {}
QByteArray store;
QByteArray message;
int code;
};
Storage(const QString &storageRoot, const QString &name, AccessMode mode = ReadOnly, bool allowDuplicates = false);
~Storage();
bool isInTransaction() const;
bool startTransaction(AccessMode mode = ReadWrite, const std::function<void(const Storage::Error &error)> &errorHandler = std::function<void(const Storage::Error &error)>());
bool commitTransaction(const std::function<void(const Storage::Error &error)> &errorHandler = std::function<void(const Storage::Error &error)>());
void abortTransaction();
/**
* Write values.
*/
bool write(const void *key, size_t keySize, const void *value, size_t valueSize, const std::function<void(const Storage::Error &error)> &errorHandler = std::function<void(const Storage::Error &error)>());
/**
* Convenience API
*/
bool write(const QByteArray &key, const QByteArray &value, const std::function<void(const Storage::Error &error)> &errorHandler = std::function<void(const Storage::Error &error)>());
/**
* Read values with a give key.
*
* * An empty @param key results in a full scan
* * If duplicates are existing (revisions), all values are returned.
* * The pointers of the returned values are valid during the execution of the @param resultHandler
*
* @return The number of values retrieved.
*/
int scan(const QByteArray &key, const std::function<bool(void *keyPtr, int keySize, void *ptr, int size)> &resultHandler, const std::function<void(const Storage::Error &error)> &errorHandler = std::function<void(const Storage::Error &error)>());
/**
* Convenience API
*/
int scan(const QByteArray &key, const std::function<bool(const QByteArray &value)> &resultHandler, const std::function<void(const Storage::Error &error)> &errorHandler = std::function<void(const Storage::Error &error)>());
/**
* Remove a value
*/
void remove(void const *key, uint keySize, const std::function<void(const Storage::Error &error)> &errorHandler = std::function<void(const Storage::Error &error)>());
/**
* Convenience API
*/
void remove(const QByteArray &key, const std::function<void(const Storage::Error &error)> &errorHandler = std::function<void(const Storage::Error &error)>());
/**
* Set the default error handler.
*/
void setDefaultErrorHandler(const std::function<void(const Storage::Error &error)> &errorHandler);
std::function<void(const Storage::Error &error)> defaultErrorHandler() const;
/**
* A basic error handler that writes to std::cerr.
*
* Used if nothing else is configured.
*/
static std::function<void(const Storage::Error &error)> basicErrorHandler();
qint64 diskUsage() const;
void removeFromDisk() const;
qint64 maxRevision();
void setMaxRevision(qint64 revision);
bool exists() const;
static bool isInternalKey(const char *key);
static bool isInternalKey(void *key, int keySize);
static bool isInternalKey(const QByteArray &key);
private:
std::function<void(const Storage::Error &error)> mErrorHandler;
private:
class Private;
Private * const d;
};
} // namespace Akonadi2
|
