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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
/**
* Copyright (C) 2018-present MongoDB, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* 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
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* <http://www.mongodb.com/licensing/server-side-public-license>.
*
* 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 Server Side 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 <string>
#include "mongo/db/repl/repl_set_config.h"
#include "mongo/util/net/hostandport.h"
namespace mongo {
class BSONObj;
class BSONObjBuilder;
class Status;
namespace repl {
/**
* Arguments to the replSetHeartbeat command.
*/
class ReplSetHeartbeatArgsV1 {
public:
/**
* Initializes this ReplSetHeartbeatArgsV1 from the contents of args.
*/
Status initialize(const BSONObj& argsObj);
/**
* Returns true if all required fields have been initialized.
*/
bool isInitialized() const;
/**
* Gets the ReplSetConfig version number of the sender.
*/
long long getConfigVersion() const {
return _configVersion;
}
/**
* Gets the ReplSetConfig term number of the sender.
*/
long long getConfigTerm() const {
return _configTerm;
}
/**
* Gets the ReplSetConfig (version, term) pair of the sender.
*/
ConfigVersionAndTerm getConfigVersionAndTerm() const {
return ConfigVersionAndTerm(_configVersion, _configTerm);
}
/**
* Gets the heartbeat version number of the sender. This field was added to ensure that
* heartbeats sent from featureCompatibilityVersion 3.6 nodes to binary version 3.4 nodes fail.
*/
long long getHeartbeatVersion() const {
return _heartbeatVersion;
}
/**
* Gets the _id of the sender in their ReplSetConfig.
*/
long long getSenderId() const {
return _senderId;
}
/**
* Gets the HostAndPort of the sender.
*/
HostAndPort getSenderHost() const {
return _senderHost;
}
/**
* Gets the replSet name of the sender's replica set.
*/
std::string getSetName() const {
return _setName;
}
/**
* Gets the term the sender believes it to be.
*/
long long getTerm() const {
return _term;
}
/**
* Returns whether or not the sender is checking for emptiness.
*/
bool hasCheckEmpty() const {
return _checkEmpty;
}
/**
* Returns whether or not the HostAndPort of the sender is set.
*/
bool hasSender() const {
return _hasSender;
}
/**
* Returns whether or not the heartbeat version of the sender is set.
*/
bool hasHeartbeatVersion() const {
return _hasHeartbeatVersion;
}
/**
* The below methods set the value in the method name to 'newVal'.
*/
void setConfigVersion(long long newVal);
void setConfigTerm(long long newVal);
void setHeartbeatVersion(long long newVal);
void setSenderId(long long newVal);
void setSenderHost(const HostAndPort& newVal);
void setSetName(const std::string& newVal);
void setTerm(long long newVal);
void setCheckEmpty();
/**
* Returns a BSONified version of the object.
* Should only be called if the mandatory fields have been set.
* Optional fields are only included if they have been set.
*/
BSONObj toBSON(bool omitConfigTerm = false) const;
void addToBSON(BSONObjBuilder* builder, bool omitConfigTerm) const;
private:
// look at the body of the isInitialized() function to see which fields are mandatory
long long _configVersion = -1;
long long _configTerm = OpTime::kUninitializedTerm;
long long _heartbeatVersion = -1;
long long _senderId = -1;
long long _term = -1;
bool _checkEmpty = false;
bool _hasSender = false;
bool _hasHeartbeatVersion = false;
std::string _setName;
HostAndPort _senderHost;
};
} // namespace repl
} // namespace mongo
|
