summaryrefslogtreecommitdiff
path: root/src/mongo/db/repl/member_heartbeat_data.h
blob: 624c572d33ff56801f9efcd6e69be0881dfad2f1 (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
/*
 *    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 "mongo/bson/optime.h"
#include "mongo/db/repl/member_state.h"
#include "mongo/db/repl/repl_set_heartbeat_response.h"
#include "mongo/util/time_support.h"

namespace mongo {
namespace repl {

    /**
     * This class contains the data returned from a heartbeat command for one member
     * of a replica set.
     **/
    class MemberHeartbeatData {
    public:
        MemberHeartbeatData();

        MemberState getState() const { return _lastResponse.getState(); }
        int getHealth() const { return _health; }
        Date_t getUpSince() const { return _upSince; }
        Date_t getLastHeartbeat() const { return _lastHeartbeat; }
        Date_t getLastHeartbeatRecv() const { return _lastHeartbeatRecv; }
        void setLastHeartbeatRecv(Date_t newHeartbeatRecvTime) {
            _lastHeartbeatRecv = newHeartbeatRecvTime;
        }
        const std::string& getLastHeartbeatMsg() const { return _lastResponse.getHbMsg(); }
        const std::string& getSyncSource() const { return _lastResponse.getSyncingTo(); }
        OpTime getOpTime() const { return _lastResponse.getOpTime(); }
        int getConfigVersion() const { return _lastResponse.getVersion(); }
        bool hasAuthIssue() const { return _authIssue; }

        OpTime getElectionTime() const { return _lastResponse.getElectionTime(); }

        // Returns true if the last heartbeat data explicilty stated that the node
        // is not electable.
        bool isUnelectable() const {
            return _lastResponse.hasIsElectable() && !_lastResponse.isElectable();
        }

        // Was this member up for the last heartbeat?
        bool up() const { return _health > 0; }
        // Was this member up for the last hearbeeat
        // (or we haven't received the first heartbeat yet)
        bool maybeUp() const { return _health != 0; }

        /**
         * Sets values in this object from the results of a successful heartbeat command.
         */
        void setUpValues(Date_t now, const HostAndPort& host, ReplSetHeartbeatResponse hbResponse);

        /**
         * Sets values in this object from the results of a erroring/failed heartbeat command.
         * _authIssues is set to false, _health is set to 0, _state is set to RS_DOWN, and
         * other values are set as specified.
         */
        void setDownValues(Date_t now, const std::string& heartbeatMessage);

        /**
         * Sets values in this object that indicate there was an auth issue on the last heartbeat
         * command.
         */
        void setAuthIssue(Date_t now);

    private:
        // -1 = not checked yet, 0 = member is down/unreachable, 1 = member is up
        int _health;

        // Time of first successful heartbeat, if currently still up
        Date_t _upSince;
        // This is the last time we got a response from a heartbeat request to a given member.
        Date_t _lastHeartbeat;
        // This is the last time we got a heartbeat request from a given member.
        Date_t _lastHeartbeatRecv;

        // Did the last heartbeat show a failure to authenticate?
        bool _authIssue;

        // The last heartbeat response we received.
        ReplSetHeartbeatResponse _lastResponse;
    };

} // namespace repl
} // namespace mongo