Seastar
High performance C++ framework for concurrent servers
sleep.hh
Go to the documentation of this file.
1/*
2 * This file is open source software, licensed to you under the terms
3 * of the Apache License, Version 2.0 (the "License"). See the NOTICE file
4 * distributed with this work for additional information regarding copyright
5 * ownership. You may not use this file except in compliance with the License.
6 *
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing,
12 * software distributed under the License is distributed on an
13 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14 * KIND, either express or implied. See the License for the
15 * specific language governing permissions and limitations
16 * under the License.
17 */
18
19/*
20 * Copyright (C) 2015 Cloudius Systems, Ltd.
21 */
22
23#pragma once
24
25#ifndef SEASTAR_MODULE
26#include <chrono>
27
28#include <seastar/core/abort_source.hh>
29#include <seastar/core/future.hh>
30#include <seastar/core/lowres_clock.hh>
31#include <seastar/core/manual_clock.hh>
32#include <seastar/core/timer.hh>
33#include <seastar/util/modules.hh>
34#endif
35
36namespace seastar {
37
38SEASTAR_MODULE_EXPORT_BEGIN
39
41
47template <typename Clock = steady_clock_type, typename Rep, typename Period>
48future<> sleep(std::chrono::duration<Rep, Period> dur) {
49 struct sleeper {
50 promise<> done;
51 timer<Clock> tmr;
52 sleeper(std::chrono::duration<Rep, Period> dur)
53 : tmr([this] { done.set_value(); })
54 {
55 tmr.arm(dur);
56 }
57 };
58 auto s = std::make_unique<sleeper>(dur);
59 future<> fut = s->done.get_future();
60 return fut.finally([s = std::move(s)] {});
61}
62
65public:
67 virtual const char* what() const noexcept {
68 return "Sleep is aborted";
69 }
70};
71
78template <typename Clock = steady_clock_type>
79future<> sleep_abortable(typename Clock::duration dur);
80
81extern template future<> sleep_abortable<steady_clock_type>(typename steady_clock_type::duration);
82extern template future<> sleep_abortable<lowres_clock>(typename lowres_clock::duration);
83
92template <typename Clock = steady_clock_type>
93future<> sleep_abortable(typename Clock::duration dur, abort_source& as);
94
95extern template future<> sleep_abortable<steady_clock_type>(typename steady_clock_type::duration, abort_source&);
96extern template future<> sleep_abortable<lowres_clock>(typename lowres_clock::duration, abort_source&);
97extern template future<> sleep_abortable<manual_clock>(typename manual_clock::duration, abort_source&);
98
99SEASTAR_MODULE_EXPORT_END
100}
Definition: abort_source.hh:48
Definition: abort_source.hh:58
A representation of a possibly not-yet-computed value.
Definition: future.hh:1240
future< T > finally(Func &&func) noexcept
Definition: future.hh:1640
void set_value(A &&... a) noexcept
Sets the promises value.
Definition: future.hh:990
exception that is thrown when application is in process of been stopped
Definition: sleep.hh:64
virtual const char * what() const noexcept
Reports the exception reason.
Definition: sleep.hh:67
void arm(time_point until, std::optional< duration > period={}) noexcept
Seastar API namespace.
Definition: abort_on_ebadf.hh:26
future sleep_abortable(typename Clock::duration dur)
future sleep(std::chrono::duration< Rep, Period > dur)
Definition: sleep.hh:48