1 // Copyright 2020 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_preprocessor/util.h" 17 18 #ifdef __cplusplus 19 20 namespace pw::this_thread { 21 22 // Provides a hint to the implementation to reschedule the execution of threads, 23 // allowing other threads to run. 24 // 25 // The exact behavior of this function depends on the implementation, in 26 // particular on the mechanics of the OS scheduler in use and the state of the 27 // system. 28 // 29 // Precondition: This can only be called from a thread, meaning the scheduler 30 // must be running. 31 void yield() noexcept; 32 33 } // namespace pw::this_thread 34 35 // The backend can opt to include an inline implementation. 36 #if __has_include("pw_thread_backend/yield_inline.h") 37 #include "pw_thread_backend/yield_inline.h" 38 #endif // __has_include("pw_thread_backend/yield_inline.h") 39 40 #endif // __cplusplus 41 42 PW_EXTERN_C_START 43 44 void pw_this_thread_Yield(void); 45 46 PW_EXTERN_C_END 47