summaryrefslogtreecommitdiff
path: root/src/mongo/db/repl/repl_set_heartbeat_response.h
blob: a5629fbc3bf15e7a7f520e342fc0f1cd24a3773f (plain)
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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
/**
 *    Copyright (C) 2014 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 <string>

#include "mongo/db/repl/member_state.h"
#include "mongo/db/repl/replica_set_config.h"
#include "mongo/util/time_support.h"

namespace mongo {

    class BSONObj;
    class BSONObjBuilder;
    class Status;

namespace repl {

    /**
     * Response structure for the replSetHeartbeat command.
     */
    class ReplSetHeartbeatResponse {
    public:
        ReplSetHeartbeatResponse();

        /**
         * Initializes this ReplSetHeartbeatResponse from the contents of "doc".
         */
        Status initialize(const BSONObj& doc);

        /**
         * Appends all non-default values to "builder".
         */
        void addToBSON(BSONObjBuilder* builder) const;

        /**
         * Returns a BSONObj consisting of all non-default values to "builder".
         */
        BSONObj toBSON() const;

        /**
         * Returns toBSON().toString()
         */
        const std::string toString() const { return toBSON().toString(); }

        bool hasDataSet() const { return _hasDataSet; }
        bool hasData() const { return _hasData; }
        bool isMismatched() const { return _mismatch; }
        bool isReplSet() const { return _isReplSet; }
        bool isStateDisagreement() const { return _stateDisagreement; }
        const std::string& getReplicaSetName() const { return _setName; }
        bool hasState() const { return _stateSet; }
        MemberState getState() const;
        bool hasElectionTime() const { return _electionTimeSet; }
        OpTime getElectionTime() const;
        bool hasIsElectable() const { return _electableSet; }
        bool isElectable() const;
        const std::string& getHbMsg() const { return _hbmsg; }
        bool hasTime() const { return _timeSet; }
        Seconds getTime() const;
        bool hasOpTime() const { return _opTimeSet; }
        OpTime getOpTime() const;
        const std::string& getSyncingTo() const { return _syncingTo; }
        int getVersion() const { return _version; }
        bool hasConfig() const { return _configSet; }
        const ReplicaSetConfig& getConfig() const;

        /**
         * Sets _mismatch to true.
         */
        void noteMismatched() { _mismatch = true; }

        /**
         * Sets _isReplSet to true.
         */
        void noteReplSet() { _isReplSet = true; }

        /**
         * Sets _stateDisagreement to true.
         */
        void noteStateDisagreement() { _stateDisagreement = true; }

        /**
         * Sets _hasData to true, and _hasDataSet to true to indicate _hasData has been modified
         */
        void noteHasData() { _hasDataSet = _hasData = true;}

        /**
         * Sets _setName to "name".
         */
        void setSetName(std::string name) { _setName = name; }

        /**
         * Sets _state to "state".
         */
        void setState(MemberState state) { _stateSet = true; _state = state; }

        /**
         * Sets the optional "electionTime" field to the given OpTime.
         */
        void setElectionTime(OpTime time) { _electionTimeSet = true; _electionTime = time; }

        /**
         * Sets _electable to "electable" and sets _electableSet to true to indicate
         * that the value of _electable has been modified.
         */
        void setElectable(bool electable) { _electableSet = true; _electable = electable; }

        /**
         * Sets _hbmsg to "hbmsg".
         */
        void setHbMsg(std::string hbmsg) { _hbmsg = hbmsg; }

        /**
         * Sets the optional "time" field of the response to "theTime", which is 
         * a count of seconds since the UNIX epoch.
         */
        void setTime(Seconds theTime) { _timeSet = true; _time = theTime; }

        /**
         * Sets _opTime to "time" and sets _opTimeSet to true to indicate that the value
         * of _opTime has been modified.
         */
        void setOpTime(OpTime time) { _opTimeSet = true; _opTime = time; }

        /**
         * Sets _syncingTo to "syncingTo".
         */
        void setSyncingTo(std::string syncingTo) { _syncingTo = syncingTo; }

        /**
         * Sets _version to "version".
         */
        void setVersion(int version) { _version = version; }

        /**
         * Initializes _config with "config".
         */
        void setConfig(const ReplicaSetConfig& config) { _configSet = true; _config = config; }

    private:
        bool _electionTimeSet;
        OpTime _electionTime;

        bool _timeSet;
        Seconds _time;  // Seconds since UNIX epoch.

        bool _opTimeSet;
        OpTime _opTime;

        bool _electableSet;
        bool _electable;

        bool _hasDataSet;
        bool _hasData;

        bool _mismatch;
        bool _isReplSet;
        bool _stateDisagreement;

        bool _stateSet;
        MemberState _state;

        int _version;
        std::string _setName;
        std::string _hbmsg;
        std::string _syncingTo;

        bool _configSet;
        ReplicaSetConfig _config;
    };

} // namespace repl
} // namespace mongo