aboutsummaryrefslogtreecommitdiffstats
path: root/searchcore/src/vespa/searchcore/proton/server/isummaryadapter.h
blob: a17bcbe6449234d7c5a910dde2dd5db89a998e97 (plain) (blame)
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
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
#pragma once

#include <vespa/searchlib/query/base.h>
#include <vespa/searchlib/common/serialnum.h>
#include <memory>

namespace document {
    class Document;
    class DocumentTypeRepo;
}
namespace search { class IDocumentStore; }
namespace vespalib { class nbostream; }

namespace proton {

/**
 * Interface for a summary adapter.
 **/
class ISummaryAdapter {
public:
    using UP = std::unique_ptr<ISummaryAdapter>;
    using SP = std::shared_ptr<ISummaryAdapter>;
    using SerialNum = search::SerialNum;
    using Document = document::Document;
    using DocumentIdT = search::DocumentIdT;
    using DocumentTypeRepo = document::DocumentTypeRepo;

    virtual ~ISummaryAdapter() {}

    // feed interface
    virtual void put(SerialNum serialNum, const DocumentIdT lid, const Document &doc) = 0;
    virtual void put(SerialNum serialNum, const DocumentIdT lid, const vespalib::nbostream & os) = 0;
    virtual void remove(SerialNum serialNum, const DocumentIdT lid) = 0;
    virtual void heartBeat(SerialNum serialNum) = 0;
    virtual const search::IDocumentStore &getDocumentStore() const = 0;
    virtual std::unique_ptr<Document> get(const DocumentIdT lid, const DocumentTypeRepo &repo) = 0;
    virtual void compactLidSpace(uint32_t wantedDocIdLimit) = 0;
};

} // namespace proton