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

namespace pw::thread {

// A callback that is executed for each thread when using ForEachThread(). The
// callback should return a struct reference for each thread iteration.
//
// This ThreadCallback should be treated as if the scheduler may be disabled,
// meaning:
// - Processing inside of the callback should be kept to a minimum.
// - Callback should never attempt to block.
using ThreadCallback = pw::Function<bool(const ThreadInfo&)>;

// Iterates through all threads that haven't been deleted, calling the provided
// callback on each thread.
//
// Warning: This may disable the scheduler.
Status ForEachThread(const ThreadCallback& cb);

}  // namespace pw::thread