summaryrefslogtreecommitdiff
path: root/src/mongo/db/server_options_server_helpers.h
diff options
context:
space:
mode:
authorHenrik Edin <henrik.edin@mongodb.com>2018-05-31 10:57:22 -0400
committerHenrik Edin <henrik.edin@mongodb.com>2018-06-07 12:06:59 -0400
commitc145be9589b0b25084cd674450a32289d511a166 (patch)
treea15dd07b0f823094bde27edf0d57a56b70bec4c5 /src/mongo/db/server_options_server_helpers.h
parentda63637defad5975040f8eac0e98c86c8d8e2533 (diff)
downloadmongo-c145be9589b0b25084cd674450a32289d511a166.tar.gz
SERVER-35297 Split server_options and server_status into two pieces.
Similarly to how commands are setup, so embedded can depend on a smaller library with fewer dependencies.
Diffstat (limited to 'src/mongo/db/server_options_server_helpers.h')
-rw-r--r--src/mongo/db/server_options_server_helpers.h86
1 files changed, 86 insertions, 0 deletions
diff --git a/src/mongo/db/server_options_server_helpers.h b/src/mongo/db/server_options_server_helpers.h
new file mode 100644
index 00000000000..a22ff251edb
--- /dev/null
+++ b/src/mongo/db/server_options_server_helpers.h
@@ -0,0 +1,86 @@
+/*
+ * Copyright (C) 2013 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/base/status.h"
+#include "mongo/util/options_parser/environment.h"
+#include "mongo/util/options_parser/option_section.h"
+
+namespace mongo {
+
+namespace optionenvironment {
+class OptionSection;
+class Environment;
+} // namespace optionenvironment
+
+namespace moe = mongo::optionenvironment;
+
+/**
+ * General server options for most standalone applications. Includes addBaseServerOptions.
+ */
+Status addGeneralServerOptions(moe::OptionSection* options);
+
+Status addWindowsServerOptions(moe::OptionSection* options);
+
+Status addSSLServerOptions(moe::OptionSection* options);
+
+/**
+ * Handle custom validation of server options that can not currently be done by using
+ * Constraints in the Environment. See the "validate" function in the Environment class for
+ * more details.
+ */
+Status validateServerOptions(const moe::Environment& params);
+
+/**
+ * Canonicalize server options for the given environment.
+ *
+ * For example, the options "objcheck", "noobjcheck", and "net.wireObjectCheck" should all be
+ * merged into "net.wireObjectCheck".
+ */
+Status canonicalizeServerOptions(moe::Environment* params);
+
+/**
+ * Sets up the global server state necessary to be able to store the server options, based on how
+ * the server was started.
+ *
+ * For example, saves the current working directory in serverGlobalParams.cwd so that relative paths
+ * in server options can be interpreted correctly.
+ */
+Status setupServerOptions(const std::vector<std::string>& args);
+
+/**
+ * Store the given parsed params in global server state.
+ *
+ * For example, sets the serverGlobalParams.port variable based on the net.port config parameter.
+ */
+Status storeServerOptions(const moe::Environment& params);
+
+void printCommandLineOpts();
+
+} // namespace mongo