blob: 856c8a22652f3bdc7a05dec2782f846d75271748 (
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
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
|
// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
#pragma once
#include <vespa/persistence/spi/persistenceprovider.h>
#include <vespa/vespalib/util/exception.h>
#include <vespa/vespalib/util/sync.h>
#include <atomic>
namespace proton {
typedef std::unique_ptr<storage::spi::Result> ResultUP;
/**
* This class is used by the FeedEngine to encapsulate the necessary information
* for an IFeedHandler to perform an async reply to an operation. A unique
* instance of this class is passed to every invokation of the IFeedHandler.
*/
class FeedToken {
public:
class ITransport {
public:
virtual ~ITransport() { }
virtual void send(ResultUP result, bool documentWasFound) = 0;
};
private:
class State {
public:
State(const State &) = delete;
State & operator = (const State &) = delete;
State(ITransport & transport, uint32_t numAcksRequired);
~State();
void incNeededAcks();
void ack();
void fail();
void setResult(ResultUP result, bool documentWasFound) {
_documentWasFound = documentWasFound;
_result = std::move(result);
}
const storage::spi::Result &getResult() { return *_result; }
private:
ITransport &_transport;
ResultUP _result;
bool _documentWasFound;
std::atomic<uint32_t> _unAckedCount;
};
std::shared_ptr<State> _state;
public:
typedef std::unique_ptr<FeedToken> UP;
typedef std::shared_ptr<FeedToken> SP;
/**
* Constructs a unique FeedToken. This is the constructor used by the
* FeedEngine when processing input. If the given message is empty, or it
* does not belong to the document protocol, this method throws a
* vespalib::IllegalArgumentException.
*
* @param transport The transport to pass the reply to.
*/
FeedToken(ITransport &transport);
FeedToken(FeedToken &&) = default;
FeedToken & operator =(FeedToken &&) = default;
FeedToken(const FeedToken &) = default;
FeedToken & operator =(const FeedToken &) = default;
~FeedToken() = default;
/**
* Passes a receipt back to the originating FeedEngine, declaring that this
* operation succeeded. If an error occured while processing the operation,
* use fail() instead. Invoking this and/or fail() more than once is void.
*/
void ack() const { _state->ack(); }
void incNeededAcks() const {
_state->incNeededAcks();
}
/**
* Passes a receipt back to the originating FeedEngine, declaring that this
* operation failed for some reason. Invoking this and/or fail() more than
* once is void.
*
* @param errNum A numerical representation of the error.
* @param errMsg A readable string detailing the error.
*/
void fail() const { _state->fail(); }
/**
* Gives you access to the underlying result.
*
* @return The result
*/
const storage::spi::Result &getResult() const { return _state->getResult(); }
/**
* Sets the underlying result.
*/
void setResult(ResultUP result, bool documentWasFound) {
_state->setResult(std::move(result), documentWasFound);
}
};
} // namespace proton
|