summaryrefslogtreecommitdiff
path: root/src/mongo/util/tick_source.h
diff options
context:
space:
mode:
authorRandolph Tan <randolph@10gen.com>2015-06-10 18:19:51 -0400
committerRandolph Tan <randolph@10gen.com>2015-06-12 15:00:55 -0400
commitc46879fbb958214170d2f75edaf58f29547b8cba (patch)
tree6ee5d9bc09f1e248d7347aec9b2cce893593eaf8 /src/mongo/util/tick_source.h
parentd33a3062941a2fc802df733ea273ac2910c61433 (diff)
downloadmongo-c46879fbb958214170d2f75edaf58f29547b8cba.tar.gz
SERVER-18922 Refactor Timer to have customizable tick source
Diffstat (limited to 'src/mongo/util/tick_source.h')
-rw-r--r--src/mongo/util/tick_source.h54
1 files changed, 54 insertions, 0 deletions
diff --git a/src/mongo/util/tick_source.h b/src/mongo/util/tick_source.h
new file mode 100644
index 00000000000..90d952c4e4e
--- /dev/null
+++ b/src/mongo/util/tick_source.h
@@ -0,0 +1,54 @@
+/**
+ * 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 <cstdint>
+
+namespace mongo {
+
+ /**
+ * Interface for objects generating ticks that roughly represents the passage of time.
+ */
+ class TickSource {
+ public:
+ using Tick = int64_t;
+
+ virtual ~TickSource() = default;
+
+ /**
+ * Returns the current tick count from this source.
+ */
+ virtual Tick getTicks() = 0;
+
+ /**
+ * Returns the conversion ratio from ticks to seconds.
+ */
+ virtual Tick getTicksPerSecond() = 0;
+ };
+} // namespace mongo