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 #include <chrono>
26 #include <functional>
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/timer.hh>
32 
33 namespace seastar {
34 
36 
42 template <typename Clock = steady_clock_type, typename Rep, typename Period>
43 future<> sleep(std::chrono::duration<Rep, Period> dur) {
44  struct sleeper {
45  promise<> done;
46  timer<Clock> tmr;
47  sleeper(std::chrono::duration<Rep, Period> dur)
48  : tmr([this] { done.set_value(); })
49  {
50  tmr.arm(dur);
51  }
52  };
53  sleeper *s = new sleeper(dur);
54  future<> fut = s->done.get_future();
55  return fut.then([s] { delete s; });
56 }
57 
59 class sleep_aborted : public std::exception {
60 public:
62  virtual const char* what() const noexcept {
63  return "Sleep is aborted";
64  }
65 };
66 
73 template <typename Clock = steady_clock_type>
74 future<> sleep_abortable(typename Clock::duration dur);
75 
76 extern template future<> sleep_abortable<steady_clock_type>(typename steady_clock_type::duration);
77 extern template future<> sleep_abortable<lowres_clock>(typename lowres_clock::duration);
78 
87 template <typename Clock = steady_clock_type>
88 future<> sleep_abortable(typename Clock::duration dur, abort_source& as);
89 
90 extern template future<> sleep_abortable<steady_clock_type>(typename steady_clock_type::duration, abort_source&);
91 extern template future<> sleep_abortable<lowres_clock>(typename lowres_clock::duration, abort_source&);
92 
93 }
Definition: abort_source.hh:51
A representation of a possibly not-yet-computed value.
Definition: future.hh:1337
Result then(Func &&func) noexcept
Schedule a block of code to run when the future is ready.
Definition: future.hh:1513
promise - allows a future value to be made available at a later time.
Definition: future.hh:957
void set_value(A &&... a) noexcept
Sets the promises value.
Definition: future.hh:1013
exception that is thrown when application is in process of been stopped
Definition: sleep.hh:59
virtual const char * what() const noexcept
Reports the exception reason.
Definition: sleep.hh:62
void arm(time_point until, std::optional< duration > period={}) noexcept
Seastar API namespace.
Definition: abort_on_ebadf.hh:24
future sleep_abortable(typename Clock::duration dur)
future sleep(std::chrono::duration< Rep, Period > dur)
Definition: sleep.hh:43