1 // Copyright 2021 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 "RTOS.h" 17 #include "pw_function/function.h" 18 #include "pw_status/status.h" 19 20 namespace pw::thread::embos { 21 22 // A callback that is executed for each thread when using ForEachThread(). The 23 // callback should return true if thread iteration should continue. When this 24 // callback returns false, ForEachThread() will cease iteration of threads and 25 // return an `Aborted` error code. 26 using ThreadCallback = pw::Function<bool(const OS_TASK&)>; 27 28 // Iterates through all threads that haven't been deleted, calling the provided 29 // callback on each thread. 30 // 31 // Precondition: 32 // OS_Start() must be called prior to using this function. 33 // 34 // Returns: 35 // FailedPrecondition - The scheduler has not yet been initialized. 36 // Aborted - The callback requested an early-termination of thread iteration. 37 // OkStatus - Successfully iterated over all threads. 38 // 39 // Warning: This is only safe to use when the scheduler is disabled. 40 Status ForEachThread(const ThreadCallback& cb); 41 42 namespace internal { 43 44 // This function is exposed for testing. Prefer 45 // pw::thread::embos::ForEachThread. 46 Status ForEachThread(const OS_TASK& starting_thread, const ThreadCallback& cb); 47 48 } // namespace internal 49 } // namespace pw::thread::embos 50