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
|
/**
* Copyright (C) 2017 MongoDB Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the GNU Affero General Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
#pragma once
#include "mongo/bson/oid.h"
#include "mongo/db/repl/optime.h"
namespace mongo {
class BSONObj;
class BSONObjBuilder;
namespace rpc {
extern const char kOplogQueryMetadataFieldName[];
/**
* Represents the metadata information for $oplogQueryData.
*/
class OplogQueryMetadata {
public:
/**
* Default primary index. Also used to indicate in metadata that there is no
* primary.
*/
static const int kNoPrimary = -1;
OplogQueryMetadata() = default;
OplogQueryMetadata(repl::OpTime lastOpCommitted,
repl::OpTime lastOpApplied,
int rbid,
int currentPrimaryIndex,
int currentSyncSourceIndex);
/**
* format:
* {
* lastOpCommitted: {ts: Timestamp(0, 0), term: 0},
* lastOpApplied: {ts: Timestamp(0, 0), term: 0},
* rbid: 0
* primaryIndex: 0,
* syncSourceIndex: 0
* }
*/
static StatusWith<OplogQueryMetadata> readFromMetadata(const BSONObj& doc);
Status writeToMetadata(BSONObjBuilder* builder) const;
/**
* Returns the OpTime of the most recently committed op of which the sender was aware.
*/
repl::OpTime getLastOpCommitted() const {
return _lastOpCommitted;
}
/**
* Returns the OpTime of the most recent operation to be applied by the sender.
*/
repl::OpTime getLastOpApplied() const {
return _lastOpApplied;
}
/**
* Returns the index of the current primary from the perspective of the sender.
* Returns kNoPrimary if there is no primary.
*/
int getPrimaryIndex() const {
return _currentPrimaryIndex;
}
/**
* Returns the index of the sync source of the sender.
* Returns -1 if it has no sync source.
*/
int getSyncSourceIndex() const {
return _currentSyncSourceIndex;
}
/**
* Returns the current rbid of the sender.
*/
int getRBID() const {
return _rbid;
}
/**
* Returns a stringified version of the metadata.
*/
std::string toString() const;
private:
repl::OpTime _lastOpCommitted;
repl::OpTime _lastOpApplied;
int _rbid = -1;
int _currentPrimaryIndex = kNoPrimary;
int _currentSyncSourceIndex = -1;
};
} // namespace rpc
} // namespace mongo
|
