SERVER-18191 make new heartbeat args/response classes for the new election protocol

1 files changed, 108 insertions, 0 deletions

diff --git a/src/mongo/db/repl/repl_set_heartbeat_args_v1.h b/src/mongo/db/repl/repl_set_heartbeat_args_v1.h
new file mode 100644
index 00000000000..cc7332b23ce
--- /dev/null
+++ b/src/mongo/db/repl/repl_set_heartbeat_args_v1.h
@@ -0,0 +1,108 @@
+/**
+ *    Copyright (C) 2015 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 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 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 term the sender believes it to be.
+         */
+        long long getTerm() const { return _term; }
+
+        /**
+         * The below methods set the value in the method name to 'newVal'.
+         */
+        void setConfigVersion(long long newVal);
+        void setProtocolVersion(long long newVal);
+        void setSenderId(long long newVal);
+        void setSetName(std::string newVal);
+        void setTerm(long long 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:
+        // look at the body of the isInitialized() function to see which fields are mandatory
+        long long _configVersion = -1;
+        long long _protocolVersion = -1;
+        long long _senderId = -1;
+        long long _term = -1;
+        std::string _setName;
+    };
+
+} // namespace repl
+} // namespace mongo