1 // Copyright 2022 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 <utility> 17 18 #include "pw_async/dispatcher.h" 19 #include "pw_async/task_function.h" 20 #include "pw_status/status.h" 21 22 namespace pw::async { 23 24 /// FunctionDispatcher extends Dispatcher with Post*() methods that take a 25 /// TaskFunction instead of a Task. This implies that Tasks are allocated or 26 /// are taken from a Task pool. Tasks are owned and managed by the Dispatcher. 27 class FunctionDispatcher : public Dispatcher { 28 public: 29 ~FunctionDispatcher() override = default; 30 31 // Prevent hiding of overloaded virtual methods. 32 using Dispatcher::Post; 33 using Dispatcher::PostAfter; 34 using Dispatcher::PostAt; 35 36 /// Post dispatcher owned |task_func| function. Post(TaskFunction && task_func)37 virtual Status Post(TaskFunction&& task_func) { 38 return PostAt(std::move(task_func), now()); 39 } 40 41 /// Post dispatcher owned |task_func| function to be run after |delay|. PostAfter(TaskFunction && task_func,chrono::SystemClock::duration delay)42 virtual Status PostAfter(TaskFunction&& task_func, 43 chrono::SystemClock::duration delay) { 44 return PostAt(std::move(task_func), now() + delay); 45 } 46 47 /// Post dispatcher owned |task_func| function to be run at |time|. 48 virtual Status PostAt(TaskFunction&& task_func, 49 chrono::SystemClock::time_point time) = 0; 50 }; 51 52 } // namespace pw::async 53