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 "pw_function/function.h" 17 #include "pw_status/status.h" 18 #include "pw_thread/thread_info.h" 19 20 namespace pw::thread { 21 22 // A callback that is executed for each thread when using ForEachThread(). The 23 // callback should return a struct reference for each thread iteration. 24 // 25 // This ThreadCallback should be treated as if the scheduler may be disabled, 26 // meaning: 27 // - Processing inside of the callback should be kept to a minimum. 28 // - Callback should never attempt to block. 29 using ThreadCallback = pw::Function<bool(const ThreadInfo&)>; 30 31 // Iterates through all threads that haven't been deleted, calling the provided 32 // callback on each thread. 33 // 34 // Warning: This may disable the scheduler. 35 Status ForEachThread(const ThreadCallback& cb); 36 37 } // namespace pw::thread 38