pw_async/public/pw_async/context.h

// Copyright 2023 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 "pw_function/function.h"
#include "pw_status/status.h"

namespace pw::async {

class Dispatcher;
class Task;

/// Contextual information provided by a `Dispatcher` to a running task.
struct Context {
  /// The `Dispatcher` running the current `Task`.
  Dispatcher* dispatcher;
  /// The current ``Task`` being executed.
  Task* task;
};

}  // namespace pw::async