xref: /aosp_15_r20/frameworks/native/include/ftl/details/future.h (revision 38e8c45f13ce32b0dcecb25141ffecaf386fa17f)
1*38e8c45fSAndroid Build Coastguard Worker /*
2*38e8c45fSAndroid Build Coastguard Worker  * Copyright 2022 The Android Open Source Project
3*38e8c45fSAndroid Build Coastguard Worker  *
4*38e8c45fSAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
5*38e8c45fSAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
6*38e8c45fSAndroid Build Coastguard Worker  * You may obtain a copy of the License at
7*38e8c45fSAndroid Build Coastguard Worker  *
8*38e8c45fSAndroid Build Coastguard Worker  *      http://www.apache.org/licenses/LICENSE-2.0
9*38e8c45fSAndroid Build Coastguard Worker  *
10*38e8c45fSAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
11*38e8c45fSAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
12*38e8c45fSAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*38e8c45fSAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
14*38e8c45fSAndroid Build Coastguard Worker  * limitations under the License.
15*38e8c45fSAndroid Build Coastguard Worker  */
16*38e8c45fSAndroid Build Coastguard Worker 
17*38e8c45fSAndroid Build Coastguard Worker #pragma once
18*38e8c45fSAndroid Build Coastguard Worker 
19*38e8c45fSAndroid Build Coastguard Worker namespace android::ftl {
20*38e8c45fSAndroid Build Coastguard Worker 
21*38e8c45fSAndroid Build Coastguard Worker template <typename, template <typename> class>
22*38e8c45fSAndroid Build Coastguard Worker class Future;
23*38e8c45fSAndroid Build Coastguard Worker 
24*38e8c45fSAndroid Build Coastguard Worker namespace details {
25*38e8c45fSAndroid Build Coastguard Worker 
26*38e8c45fSAndroid Build Coastguard Worker template <typename T>
27*38e8c45fSAndroid Build Coastguard Worker struct future_result {
28*38e8c45fSAndroid Build Coastguard Worker   using type = T;
29*38e8c45fSAndroid Build Coastguard Worker };
30*38e8c45fSAndroid Build Coastguard Worker 
31*38e8c45fSAndroid Build Coastguard Worker template <typename T>
32*38e8c45fSAndroid Build Coastguard Worker struct future_result<std::future<T>> {
33*38e8c45fSAndroid Build Coastguard Worker   using type = T;
34*38e8c45fSAndroid Build Coastguard Worker };
35*38e8c45fSAndroid Build Coastguard Worker 
36*38e8c45fSAndroid Build Coastguard Worker template <typename T>
37*38e8c45fSAndroid Build Coastguard Worker struct future_result<std::shared_future<T>> {
38*38e8c45fSAndroid Build Coastguard Worker   using type = T;
39*38e8c45fSAndroid Build Coastguard Worker };
40*38e8c45fSAndroid Build Coastguard Worker 
41*38e8c45fSAndroid Build Coastguard Worker template <typename T, template <typename> class FutureImpl>
42*38e8c45fSAndroid Build Coastguard Worker struct future_result<Future<T, FutureImpl>> {
43*38e8c45fSAndroid Build Coastguard Worker   using type = T;
44*38e8c45fSAndroid Build Coastguard Worker };
45*38e8c45fSAndroid Build Coastguard Worker 
46*38e8c45fSAndroid Build Coastguard Worker template <typename T>
47*38e8c45fSAndroid Build Coastguard Worker using future_result_t = typename future_result<T>::type;
48*38e8c45fSAndroid Build Coastguard Worker 
49*38e8c45fSAndroid Build Coastguard Worker struct ValueTag {};
50*38e8c45fSAndroid Build Coastguard Worker 
51*38e8c45fSAndroid Build Coastguard Worker template <typename, typename T, template <typename> class>
52*38e8c45fSAndroid Build Coastguard Worker class BaseFuture;
53*38e8c45fSAndroid Build Coastguard Worker 
54*38e8c45fSAndroid Build Coastguard Worker template <typename Self, typename T>
55*38e8c45fSAndroid Build Coastguard Worker class BaseFuture<Self, T, std::future> {
56*38e8c45fSAndroid Build Coastguard Worker   using Impl = std::future<T>;
57*38e8c45fSAndroid Build Coastguard Worker 
58*38e8c45fSAndroid Build Coastguard Worker  public:
59*38e8c45fSAndroid Build Coastguard Worker   Future<T, std::shared_future> share() {
60*38e8c45fSAndroid Build Coastguard Worker     if (T* value = std::get_if<T>(&self())) {
61*38e8c45fSAndroid Build Coastguard Worker       return {ValueTag{}, std::move(*value)};
62*38e8c45fSAndroid Build Coastguard Worker     }
63*38e8c45fSAndroid Build Coastguard Worker 
64*38e8c45fSAndroid Build Coastguard Worker     return std::get<Impl>(self()).share();
65*38e8c45fSAndroid Build Coastguard Worker   }
66*38e8c45fSAndroid Build Coastguard Worker 
67*38e8c45fSAndroid Build Coastguard Worker  protected:
68*38e8c45fSAndroid Build Coastguard Worker   T get() {
69*38e8c45fSAndroid Build Coastguard Worker     if (T* value = std::get_if<T>(&self())) {
70*38e8c45fSAndroid Build Coastguard Worker       return std::move(*value);
71*38e8c45fSAndroid Build Coastguard Worker     }
72*38e8c45fSAndroid Build Coastguard Worker 
73*38e8c45fSAndroid Build Coastguard Worker     return std::get<Impl>(self()).get();
74*38e8c45fSAndroid Build Coastguard Worker   }
75*38e8c45fSAndroid Build Coastguard Worker 
76*38e8c45fSAndroid Build Coastguard Worker   template <class Rep, class Period>
77*38e8c45fSAndroid Build Coastguard Worker   std::future_status wait_for(const std::chrono::duration<Rep, Period>& timeout_duration) const {
78*38e8c45fSAndroid Build Coastguard Worker     if (std::holds_alternative<T>(self())) {
79*38e8c45fSAndroid Build Coastguard Worker       return std::future_status::ready;
80*38e8c45fSAndroid Build Coastguard Worker     }
81*38e8c45fSAndroid Build Coastguard Worker 
82*38e8c45fSAndroid Build Coastguard Worker     return std::get<Impl>(self()).wait_for(timeout_duration);
83*38e8c45fSAndroid Build Coastguard Worker   }
84*38e8c45fSAndroid Build Coastguard Worker 
85*38e8c45fSAndroid Build Coastguard Worker  private:
86*38e8c45fSAndroid Build Coastguard Worker   auto& self() { return static_cast<Self&>(*this).future_; }
87*38e8c45fSAndroid Build Coastguard Worker   const auto& self() const { return static_cast<const Self&>(*this).future_; }
88*38e8c45fSAndroid Build Coastguard Worker };
89*38e8c45fSAndroid Build Coastguard Worker 
90*38e8c45fSAndroid Build Coastguard Worker template <typename Self, typename T>
91*38e8c45fSAndroid Build Coastguard Worker class BaseFuture<Self, T, std::shared_future> {
92*38e8c45fSAndroid Build Coastguard Worker   using Impl = std::shared_future<T>;
93*38e8c45fSAndroid Build Coastguard Worker 
94*38e8c45fSAndroid Build Coastguard Worker  protected:
95*38e8c45fSAndroid Build Coastguard Worker   const T& get() const {
96*38e8c45fSAndroid Build Coastguard Worker     if (const T* value = std::get_if<T>(&self())) {
97*38e8c45fSAndroid Build Coastguard Worker       return *value;
98*38e8c45fSAndroid Build Coastguard Worker     }
99*38e8c45fSAndroid Build Coastguard Worker 
100*38e8c45fSAndroid Build Coastguard Worker     return std::get<Impl>(self()).get();
101*38e8c45fSAndroid Build Coastguard Worker   }
102*38e8c45fSAndroid Build Coastguard Worker 
103*38e8c45fSAndroid Build Coastguard Worker   template <class Rep, class Period>
104*38e8c45fSAndroid Build Coastguard Worker   std::future_status wait_for(const std::chrono::duration<Rep, Period>& timeout_duration) const {
105*38e8c45fSAndroid Build Coastguard Worker     if (std::holds_alternative<T>(self())) {
106*38e8c45fSAndroid Build Coastguard Worker       return std::future_status::ready;
107*38e8c45fSAndroid Build Coastguard Worker     }
108*38e8c45fSAndroid Build Coastguard Worker 
109*38e8c45fSAndroid Build Coastguard Worker     return std::get<Impl>(self()).wait_for(timeout_duration);
110*38e8c45fSAndroid Build Coastguard Worker   }
111*38e8c45fSAndroid Build Coastguard Worker 
112*38e8c45fSAndroid Build Coastguard Worker  private:
113*38e8c45fSAndroid Build Coastguard Worker   const auto& self() const { return static_cast<const Self&>(*this).future_; }
114*38e8c45fSAndroid Build Coastguard Worker };
115*38e8c45fSAndroid Build Coastguard Worker 
116*38e8c45fSAndroid Build Coastguard Worker }  // namespace details
117*38e8c45fSAndroid Build Coastguard Worker }  // namespace android::ftl
118