third_party/pigweed/repo/pw_thread/public/pw_thread/yield.h

   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 // This can only be called from a thread, meaning the scheduler is running.
  30 void yield() noexcept;
  31
  32 }  // namespace pw::this_thread
  33
  34 // The backend can opt to include an inline implementation.
  35 #if __has_include("pw_thread_backend/yield_inline.h")
  36 #include "pw_thread_backend/yield_inline.h"
  37 #endif  // __has_include("pw_thread_backend/yield_inline.h")
  38
  39 #endif  // __cplusplus
  40
  41 PW_EXTERN_C_START
  42
  43 void pw_this_thread_Yield(void);
  44
  45 PW_EXTERN_C_END