blob: c1fa8e665d593ca5a46b436ec0ba6daa3fbaaa1d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
|
// Copyright 2022 The Pigweed Authors
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not
// use this file except in compliance with the License. You may obtain a copy of
// the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
// License for the specific language governing permissions and limitations under
// the License.
#pragma once
#include <optional>
#include "pw_async/internal/types.h"
#include "pw_async_backend/task.h"
namespace pw::async {
namespace test {
class FakeDispatcher;
}
/// A Task represents a unit of work (TaskFunction) that can be executed on a
/// Dispatcher. To support various Dispatcher backends, it wraps a
/// `backend::NativeTask`, which contains backend-specific state and methods.
class Task final {
public:
/// The default constructor creates a Task without a function.
/// `set_function()` must be called before posting the Task.
Task() : native_type_(*this) {}
/// Constructs a Task that calls `f` when executed on a Dispatcher.
explicit Task(TaskFunction&& f) : native_type_(*this, std::move(f)) {}
Task(const Task&) = delete;
Task& operator=(const Task&) = delete;
Task(Task&&) = delete;
Task& operator=(Task&&) = delete;
/// Configure the TaskFunction after construction. This MUST NOT be called
/// while this Task is pending in a Dispatcher.
void set_function(TaskFunction&& f) {
native_type_.set_function(std::move(f));
}
/// Executes this task.
void operator()(Context& ctx, Status status) { native_type_(ctx, status); }
/// Returns the inner NativeTask containing backend-specific state. Only
/// Dispatcher backends or non-portable code should call these methods!
backend::NativeTask& native_type() { return native_type_; }
const backend::NativeTask& native_type() const { return native_type_; }
private:
backend::NativeTask native_type_;
};
} // namespace pw::async
|
