summaryrefslogtreecommitdiff
path: root/src/mongo/db/repl/repl_set_heartbeat_args.h
blob: 487be758524785b53a2f2c5d246f92de41ba5a2c (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
/**
 *    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/util/net/hostandport.h"

namespace mongo {

    class BSONObj;
    class Status;

namespace repl {

    /**
     * Arguments to the replSetHeartbeat command.
     */
    class ReplSetHeartbeatArgs {
    public:
        ReplSetHeartbeatArgs();

        /**
         * Initializes this ReplSetHeartbeatArgs from the contents of args.
         */
        Status initialize(const BSONObj& argsObj);

        /**
         * Returns true if all required fields have been initialized.
         */
        bool isInitialized() const;

        /**
         * Returns whether the sender would like to know whether the node is empty or not.
         */
        bool getCheckEmpty() const { return _checkEmpty; }

        /**
         * Gets the version of the Heartbeat protocol being used by the sender.
         */
        long long getProtocolVersion() const { return _protocolVersion; }

        /**
         * Gets the ReplSetConfig version number of the sender.
         */ 
        long long getConfigVersion() const { return _configVersion; }

        /**
         * Gets the _id of the sender in their ReplSetConfig.
         */
        long long getSenderId() const { return _senderId; }

        /**
         * Gets the replSet name of the sender's replica set.
         */
        std::string getSetName() const { return _setName; }

        /**
         * Gets the HostAndPort of the sender.
         */
        HostAndPort getSenderHost() const { return _senderHost; }

        /**
         * The below methods check whether or not value in the method name has been set.
         */
        bool hasCheckEmpty() { return _hasCheckEmpty; }
        bool hasProtocolVersion() { return _hasProtocolVersion; }
        bool hasConfigVersion() { return _hasConfigVersion; }
        bool hasSenderId() { return _hasSenderId; }
        bool hasSetName() { return _hasSetName; }
        bool hasSenderHost() { return _hasSenderHost; }

        /**
         * The below methods set the value in the method name to 'newVal'.
         */
        void setCheckEmpty(bool newVal);
        void setProtocolVersion(long long newVal);
        void setConfigVersion(long long newVal);
        void setSenderId(long long newVal);
        void setSetName(std::string newVal);
        void setSenderHost(HostAndPort newVal);

        /**
         * 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() const;

    private:
        bool _hasCheckEmpty;
        bool _hasProtocolVersion;
        bool _hasConfigVersion;
        bool _hasSenderId;
        bool _hasSetName;
        bool _hasSenderHost;

        // look at the body of the isInitialized() function to see which fields are mandatory
        bool _checkEmpty;
        long long _protocolVersion;
        long long _configVersion;
        long long _senderId;
        std::string _setName;
        HostAndPort _senderHost;
    };

} // namespace repl
} // namespace mongo