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
|
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
#pragma once
#include "i_document_retriever.h"
#include "resulthandler.h"
#include <vespa/searchcore/proton/common/feedtoken.h>
namespace document {
class Document;
class DocumentUpdate;
}
namespace storage::spi { class ClusterState; }
namespace proton {
/**
* This interface describes a sync persistence operation handler. It is implemented by
* the DocumentDB and other classes, and used by the PersistenceEngine class to delegate
* operations to the appropriate db.
*/
class IPersistenceHandler {
protected:
IPersistenceHandler() = default;
using DocumentUpdateSP = std::shared_ptr<document::DocumentUpdate>;
using DocumentSP = std::shared_ptr<document::Document>;
public:
using UP = std::unique_ptr<IPersistenceHandler>;
using SP = std::shared_ptr<IPersistenceHandler>;
/// Note that you can not move awaythe handlers in the vector.
using RetrieversSP = std::shared_ptr<std::vector<IDocumentRetriever::SP> >;
IPersistenceHandler(const IPersistenceHandler &) = delete;
IPersistenceHandler & operator = (const IPersistenceHandler &) = delete;
virtual ~IPersistenceHandler() = default;
/**
* Called before all other functions so that the persistence handler
* can initialize itself before being used.
*/
virtual void initialize() = 0;
virtual void handlePut(FeedToken token, const storage::spi::Bucket &bucket,
storage::spi::Timestamp timestamp, DocumentSP doc) = 0;
virtual void handleUpdate(FeedToken token, const storage::spi::Bucket &bucket,
storage::spi::Timestamp timestamp, DocumentUpdateSP upd) = 0;
virtual void handleRemove(FeedToken token, const storage::spi::Bucket &bucket,
storage::spi::Timestamp timestamp, const document::DocumentId &id) = 0;
virtual void handleListBuckets(IBucketIdListResultHandler &resultHandler) = 0;
virtual void handleSetClusterState(const storage::spi::ClusterState &calc, IGenericResultHandler &resultHandler) = 0;
virtual void handleSetActiveState(const storage::spi::Bucket &bucket,
storage::spi::BucketInfo::ActiveState newState,
std::shared_ptr<IGenericResultHandler> resultHandler) = 0;
virtual void handleGetBucketInfo(const storage::spi::Bucket &bucket, IBucketInfoResultHandler &resultHandler) = 0;
virtual void handleCreateBucket(FeedToken token, const storage::spi::Bucket &bucket) = 0;
virtual void handleDeleteBucket(FeedToken token, const storage::spi::Bucket &bucket) = 0;
virtual void handleGetModifiedBuckets(IBucketIdListResultHandler &resultHandler) = 0;
virtual void handleSplit(FeedToken token, const storage::spi::Bucket &source,
const storage::spi::Bucket &target1, const storage::spi::Bucket &target2) = 0;
virtual void handleJoin(FeedToken token, const storage::spi::Bucket &source,
const storage::spi::Bucket &target1, const storage::spi::Bucket &target2) = 0;
virtual RetrieversSP getDocumentRetrievers(storage::spi::ReadConsistency consistency) = 0;
virtual void handleListActiveBuckets(IBucketIdListResultHandler &resultHandler) = 0;
virtual void handlePopulateActiveBuckets(document::BucketId::List buckets, IGenericResultHandler &resultHandler) = 0;
};
} // namespace proton
|