summaryrefslogtreecommitdiffstats
path: root/src/seastar/include/seastar/core/sleep.hh
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/seastar/include/seastar/core/sleep.hh93
1 files changed, 93 insertions, 0 deletions
diff --git a/src/seastar/include/seastar/core/sleep.hh b/src/seastar/include/seastar/core/sleep.hh
new file mode 100644
index 000000000..4d4db0af6
--- /dev/null
+++ b/src/seastar/include/seastar/core/sleep.hh
@@ -0,0 +1,93 @@
+/*
+ * This file is open source software, licensed to you under the terms
+ * of the Apache License, Version 2.0 (the "License"). See the NOTICE file
+ * distributed with this work for additional information regarding copyright
+ * ownership. You may not use this file except in compliance with the License.
+ *
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/*
+ * Copyright (C) 2015 Cloudius Systems, Ltd.
+ */
+
+#pragma once
+
+#include <chrono>
+#include <functional>
+
+#include <seastar/core/abort_source.hh>
+#include <seastar/core/future.hh>
+#include <seastar/core/lowres_clock.hh>
+#include <seastar/core/timer.hh>
+
+namespace seastar {
+
+/// \file
+
+/// Returns a future which completes after a specified time has elapsed.
+///
+/// \param dur minimum amount of time before the returned future becomes
+/// ready.
+/// \return A \ref future which becomes ready when the sleep duration elapses.
+template <typename Clock = steady_clock_type, typename Rep, typename Period>
+future<> sleep(std::chrono::duration<Rep, Period> dur) {
+ struct sleeper {
+ promise<> done;
+ timer<Clock> tmr;
+ sleeper(std::chrono::duration<Rep, Period> dur)
+ : tmr([this] { done.set_value(); })
+ {
+ tmr.arm(dur);
+ }
+ };
+ sleeper *s = new sleeper(dur);
+ future<> fut = s->done.get_future();
+ return fut.then([s] { delete s; });
+}
+
+/// exception that is thrown when application is in process of been stopped
+class sleep_aborted : public std::exception {
+public:
+ /// Reports the exception reason.
+ virtual const char* what() const noexcept {
+ return "Sleep is aborted";
+ }
+};
+
+/// Returns a future which completes after a specified time has elapsed
+/// or throws \ref sleep_aborted exception if application is aborted
+///
+/// \param dur minimum amount of time before the returned future becomes
+/// ready.
+/// \return A \ref future which becomes ready when the sleep duration elapses.
+template <typename Clock = steady_clock_type>
+future<> sleep_abortable(typename Clock::duration dur);
+
+extern template future<> sleep_abortable<steady_clock_type>(typename steady_clock_type::duration);
+extern template future<> sleep_abortable<lowres_clock>(typename lowres_clock::duration);
+
+/// Returns a future which completes after a specified time has elapsed
+/// or throws \ref sleep_aborted exception if the sleep is aborted.
+///
+/// \param dur minimum amount of time before the returned future becomes
+/// ready.
+/// \param as the \ref abort_source that eventually notifies that the sleep
+/// should be aborted.
+/// \return A \ref future which becomes ready when the sleep duration elapses.
+template <typename Clock = steady_clock_type>
+future<> sleep_abortable(typename Clock::duration dur, abort_source& as);
+
+extern template future<> sleep_abortable<steady_clock_type>(typename steady_clock_type::duration, abort_source&);
+extern template future<> sleep_abortable<lowres_clock>(typename lowres_clock::duration, abort_source&);
+
+}