Movatterモバイル変換


[0]ホーム

URL:


cppreference.com
Namespaces
Variants
    Actions

      std::condition_variable::wait_for

      From cppreference.com
      <cpp‎ |thread‎ |condition variable
       
       
      Concurrency support library
      Threads
      (C++11)
      (C++20)
      this_thread namespace
      (C++11)
      (C++11)
      (C++11)
      Cooperative cancellation
      Mutual exclusion
      Generic lock management
      (C++11)
      (C++11)
      (C++11)
      (C++11)
      Condition variables
      (C++11)
      Semaphores
      Latches and Barriers
      (C++20)
      (C++20)
      Futures
      (C++11)
      (C++11)
      (C++11)
      Safe reclamation
      Hazard pointers
      Atomic types
      (C++11)
      (C++20)
      Initialization of atomic types
      (C++11)(deprecated in C++20)
      (C++11)(deprecated in C++20)
      Memory ordering
      (C++11)(deprecated in C++26)
      Free functions for atomic operations
      Free functions for atomic flags
       
       
      template<class Rep,class Period>

      std::cv_status wait_for(std::unique_lock<std::mutex>& lock,

                               conststd::chrono::duration<Rep, Period>& rel_time);
      (1)(since C++11)
      template<class Rep,class Period,class Predicate>

      bool wait_for(std::unique_lock<std::mutex>& lock,
                     conststd::chrono::duration<Rep, Period>& rel_time,

                     Predicate pred);
      (2)(since C++11)

      wait_for causes the current thread to block until the condition variable is notified, the given duration has been elapsed, or a spurious wakeup occurs.pred can be optionally provided to detect spurious wakeup.

      1) Equivalent toreturn wait_until(lock,std::chrono::steady_clock::now()+ rel_time);.
      2) Equivalent toreturn wait_until(lock,std::chrono::steady_clock::now()+ rel_time, std::move(pred));.
      This overload may be used to ignore spurious awakenings while waiting for a specific condition to become true.

      Right afterwait_for returns,lock.owns_lock() istrue, andlock.mutex() is locked by the calling thread. If these postconditions cannot be satisfied[1], callsstd::terminate.

      If any of the following conditions is satisfied, the behavior is undefined:

      • lock.owns_lock() isfalse.
      • lock.mutex() is not locked by the calling thread.
      • If some other threads are also waiting on*this,lock.mutex() is different from the mutex unlocked by the waiting functions (wait,wait_for andwait_until) called on*this by those threads.
      1. This can happen if the re-locking of the mutex throws an exception.

      Contents

      [edit]Parameters

      lock - a lock which must be locked by the calling thread
      rel_time - the maximum duration to wait
      pred - the predicate to check whether the waiting can be completed
      Type requirements
      -
      Predicate must meet the requirements ofFunctionObject.
      -
      pred() must be a valid expression, and its type and value category must meet theBooleanTestable requirements.

      [edit]Return value

      1)std::cv_status::timeout ifrel_time has been elapsed since the beginning of this call, otherwisestd::cv_status::no_timeout.
      2) The latest result ofpred() before returning to the caller.

      [edit]Exceptions

      1) Timeout-related exceptions.
      2) Timeout-related exceptions, and any exception thrown bypred.

      [edit]Notes

      Even if notified under lock, overload(1) makes no guarantees about the state of the associated predicate when returning due to timeout.

      The effects ofnotify_one()/notify_all() and each of the three atomic parts ofwait()/wait_for()/wait_until() (unlock+wait, wakeup, and lock) take place in a single total order that can be viewed asmodification order of an atomic variable: the order is specific to this individual condition variable. This makes it impossible fornotify_one() to, for example, be delayed and unblock a thread that started waiting just after the call tonotify_one() was made.

      [edit]Example

      Run this code
      #include <chrono>#include <condition_variable>#include <iostream>#include <thread> std::condition_variable cv;std::mutex cv_m;// This mutex is used for three purposes:// 1) to synchronize accesses to i// 2) to synchronize accesses to std::cerr// 3) for the condition variable cvint i=0; void waits(){std::unique_lock<std::mutex> lk(cv_m);std::cerr<<"Waiting...\n";    cv.wait(lk,[]{return i==1;});std::cerr<<"...finished waiting. i == 1\n";} void signals(){std::this_thread::sleep_for(std::chrono::seconds(1));{std::lock_guard<std::mutex> lk(cv_m);std::cerr<<"Notifying...\n";}    cv.notify_all(); std::this_thread::sleep_for(std::chrono::seconds(1)); {std::lock_guard<std::mutex> lk(cv_m);        i=1;std::cerr<<"Notifying again...\n";}    cv.notify_all();} int main(){std::thread t1(waits), t2(waits), t3(waits), t4(signals);    t1.join();     t2.join();     t3.join();    t4.join();}

      Possible output:

      Waiting...Waiting...Waiting...Notifying...Notifying again......finished waiting. i == 1...finished waiting. i == 1...finished waiting. i == 1

      [edit]Defect reports

      The following behavior-changing defect reports were applied retroactively to previously published C++ standards.

      DRApplied toBehavior as publishedCorrect behavior
      LWG 2093C++11timeout-related exceptions were missing in the specificationmentions these exceptions
      LWG 2114
      (P2167R3)
      C++11convertibility tobool was too weak to reflect the expectation of implementationsrequirements strengthened
      LWG 2135C++11the behavior was unclear iflock.lock() throws an exceptioncallsstd::terminate in this case

      [edit]See also

      blocks the current thread until the condition variable is awakened
      (public member function)[edit]
      blocks the current thread until the condition variable is awakened or until specified time point has been reached
      (public member function)[edit]
      Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/thread/condition_variable/wait_for&oldid=176498"

      [8]ページ先頭

      ©2009-2025 Movatter.jp