summaryrefslogtreecommitdiff
path: root/src/mongo/util/exit.h
diff options
context:
space:
mode:
authorAndy Schwerin <schwerin@mongodb.com>2017-01-15 15:43:06 -0500
committerAndy Schwerin <schwerin@mongodb.com>2017-01-15 15:44:49 -0500
commita7e74d56036e94c3e4ed11ceeb4cd43e95209aa5 (patch)
treee90d6b26cb5f1bb26ebf95a36aa93ddf60f8c45c /src/mongo/util/exit.h
parentbe58d599fd9df085c94be3c22051f04aa3df5c13 (diff)
downloadmongo-a7e74d56036e94c3e4ed11ceeb4cd43e95209aa5.tar.gz
SERVER-27603 Rename mongo::inShutdown() to mongo::globalInShutdownDeprecated() for clarity.
Calling this function is deprecated because modules that consult it cannot engage in an orderly, coordinated shutdown. Instead, such modules tend to just stop working at some point after mongo::shutdown() is invoked, without regard to whether modules that depend on them have already shut down. As such, for clarity, this patch renames the function from mongo::inShutdown() to mongo::globalInShutdownDeprecated(). This also helps disambiguate calls to this function from calls to individual components' similarly named functions. Also, remove uncalled mongo::inShutdownStrict().
Diffstat (limited to 'src/mongo/util/exit.h')
-rw-r--r--src/mongo/util/exit.h16
1 files changed, 8 insertions, 8 deletions
diff --git a/src/mongo/util/exit.h b/src/mongo/util/exit.h
index 1aed81117a8..dd45cdddf28 100644
--- a/src/mongo/util/exit.h
+++ b/src/mongo/util/exit.h
@@ -35,15 +35,15 @@
namespace mongo {
/**
- * Quickly determines if the shutdown flag is set. May not be definitive.
+ * Determines if the shutdown flag is set.
+ *
+ * Calling this function is deprecated because modules that consult it
+ * cannot engage in an orderly, coordinated shutdown. Instead, such
+ * modules tend to just stop working at some point after mongo::shutdown() is
+ * invoked, without regard to whether modules that depend on them have
+ * already shut down.
*/
-bool inShutdown();
-
-/**
- * Definitively determines if the shutdown flag is set. Calling this is more expensive
- * than inShutdown().
- */
-bool inShutdownStrict();
+bool globalInShutdownDeprecated();
/**
* Does not return until all shutdown tasks have run.