SERVER-29009 Add a PeriodicRunner interface

1 files changed, 80 insertions, 0 deletions

diff --git a/src/mongo/util/periodic_runner.h b/src/mongo/util/periodic_runner.h
new file mode 100644
index 00000000000..c8b2d1e702a
--- /dev/null
+++ b/src/mongo/util/periodic_runner.h
@@ -0,0 +1,80 @@
+/**
+ *    Copyright (C) 2017 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.
+ */
+
+#include "mongo/base/disallow_copying.h"
+#include "mongo/stdx/functional.h"
+#include "mongo/util/time_support.h"
+
+namespace mongo {
+
+/**
+ * An interface for objects that run work items at specified intervals.
+ *
+ * Implementations may use whatever internal threading and eventing
+ * model they wish. Implementations may choose when to stop running
+ * scheduled jobs (for example, some implementations may stop running
+ * when the server is in global shutdown).
+ */
+class PeriodicRunner {
+public:
+    using Job = stdx::function<void()>;
+
+    struct PeriodicJob {
+        PeriodicJob(Job callable, Milliseconds period)
+            : job(std::move(callable)), interval(period) {}
+
+        /**
+         * A task to be run at regular intervals by the runner.
+         */
+        Job job;
+
+        /**
+         * An interval at which the job should be run. Defaults to 1 minute.
+         */
+        Milliseconds interval;
+    };
+
+    virtual ~PeriodicRunner();
+
+    /**
+     * Schedules a job to be run at periodic intervals.
+     */
+    virtual Status scheduleJob(PeriodicJob job) = 0;
+
+    /**
+     * Starts up this periodic runner.
+     */
+    virtual void startup() = 0;
+
+    /**
+     * Shuts down this periodic runner. Stops all jobs from running.
+     */
+    virtual void shutdown() = 0;
+};
+
+}  // namespace mongo