xref: /aosp_15_r20/external/pigweed/pw_async2/public/pw_async2/pend_func_task.h (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1 // Copyright 2023 The Pigweed Authors
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License"); you may not
4 // use this file except in compliance with the License. You may obtain a copy of
5 // the License at
6 //
7 //     https://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11 // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12 // License for the specific language governing permissions and limitations under
13 // the License.
14 #pragma once
15 
16 #include "pw_async2/dispatcher.h"
17 #include "pw_function/function.h"
18 
19 namespace pw::async2 {
20 
21 /// A ``Task`` that delegates to a provided function ``func``.
22 ///
23 /// The provided ``func`` may be any callable (function, lambda, or similar)
24 /// which accepts a ``Context&`` and returns a ``Poll<>``.
25 ///
26 /// The resulting ``Task`` will implement ``Pend`` by invoking ``func``.
27 template <typename Func = Function<Poll<>(Context&)> >
28 class PendFuncTask : public Task {
29  public:
30   /// Create a new ``Task`` which delegates ``Pend`` to ``func``.
31   ///
32   /// See class docs for more details.
PendFuncTask(Func && func)33   PendFuncTask(Func&& func) : func_(std::forward<Func>(func)) {}
34 
35  private:
DoPend(Context & cx)36   Poll<> DoPend(Context& cx) final { return func_(cx); }
37   Func func_;
38 };
39 
40 }  // namespace pw::async2
41