Namespaces
Variants

std::condition_variable:: wait

From cppreference.net
Concurrency support library
Threads
(C++11)
(C++20)
this_thread namespace
(C++11)
(C++11)
Cooperative cancellation
Mutual exclusion
Generic lock management
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
void wait ( std:: unique_lock < std:: mutex > & lock ) ;
(1) (seit C++11)
template < class Predicate >
void wait ( std:: unique_lock < std:: mutex > & lock, Predicate pred ) ;
(2) (seit C++11)

wait bewirkt, dass der aktuelle Thread blockiert, bis die Bedingungsvariable benachrichtigt wird oder ein spontanes Aufwachen auftritt. pred kann optional bereitgestellt werden, um spontanes Aufwachen zu erkennen.

1) Ruft atomar lock. unlock ( ) auf und blockiert auf * this .
Der Thread wird entblockt, wenn notify_all() oder notify_one() ausgeführt wird. Er kann auch sporadisch ohne Grund entblockt werden.
Wenn entsperrt, ruft lock. lock ( ) (möglicherweise blockierend auf der Sperre), dann kehrt zurück.
2) Entspricht
while ( ! pred ( ) )
wait ( lock ) ;
.
Diese Überladung kann verwendet werden, um falsche Aufweckvorgänge zu ignorieren, während auf das Eintreten einer bestimmten Bedingung gewartet wird. true .

Unmittelbar nachdem wait zurückkehrt, ist lock. owns_lock ( ) true , und lock. mutex ( ) wird vom aufrufenden Thread gesperrt. Wenn diese Nachbedingungen nicht erfüllt werden können [1] , wird std::terminate aufgerufen.

Wenn eine der folgenden Bedingungen erfüllt ist, ist das Verhalten undefiniert:

  • lock. owns_lock ( ) ist false .
  • lock. mutex ( ) ist nicht durch den aufrufenden Thread gesperrt.
  • Falls andere Threads ebenfalls auf * this warten, lock. mutex ( ) unterscheidet sich vom Mutex, der durch die Wartefunktionen ( wait , wait_for und wait_until ) auf * this durch jene Threads entsperrt wird.
  1. Dies kann passieren, wenn das erneute Sperren des Mutex eine Exception auslöst.

Inhaltsverzeichnis

Parameter

lock - eine Sperre, die vom aufrufenden Thread gesperrt werden muss
pred - das Prädikat zur Überprüfung, ob das Warten abgeschlossen werden kann
Typanforderungen
-
Predicate muss die Anforderungen von FunctionObject erfüllen.
-
pred ( ) muss ein gültiger Ausdruck sein, und sein Typ und Wertkategorie müssen die BooleanTestable Anforderungen erfüllen.

Ausnahmen

1) Wirft nichts.
2) Jede Ausnahme, die von pred geworfen wird.

Hinweise

Die Effekte von notify_one() / notify_all() und jeder der drei atomaren Teile von wait() / wait_for() / wait_until() (Entsperren+Warten, Aufwecken und Sperren) finden in einer einzigen Gesamtreihenfolge statt, die als Modifikationsreihenfolge einer atomaren Variable betrachtet werden kann: Die Reihenfolge ist spezifisch für diese individuelle Bedingungsvariable. Dies macht es unmöglich, dass notify_one() beispielsweise verzögert wird und einen Thread entsperrt, der erst nach dem Aufruf von notify_one() mit dem Warten begonnen hat.

Beispiel

#include <chrono>
#include <condition_variable>
#include <iostream>
#include <thread>
std::condition_variable cv;
std::mutex cv_m; // Dieses Mutex wird für drei Zwecke verwendet:
                 // 1) zum Synchronisieren von Zugriffen auf i
                 // 2) zum Synchronisieren von Zugriffen auf std::cerr
                 // 3) für die Condition Variable cv
int 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();
}

Mögliche Ausgabe:

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

Fehlerberichte

Die folgenden verhaltensändernden Fehlerberichte wurden rückwirkend auf zuvor veröffentlichte C++-Standards angewendet.

DR Angewendet auf Verhalten wie veröffentlicht Korrektes Verhalten
LWG 2114
( P2167R3 )
C++11 Konvertierbarkeit zu bool war zu schwach, um die Erwartungen der Implementierungen widerzuspiegeln Anforderungen verstärkt
LWG 2135 C++11 das Verhalten war unklar, falls lock. lock ( ) eine Exception wirft ruft std::terminate in diesem Fall auf

Siehe auch

blockiert den aktuellen Thread, bis die Bedingungsvariable aufgeweckt wird oder nach Ablauf der angegebenen Timeout-Dauer
(öffentliche Elementfunktion)
blockiert den aktuellen Thread, bis die Bedingungsvariable aufgeweckt wird oder der angegebene Zeitpunkt erreicht wurde
(öffentliche Elementfunktion)
C-Dokumentation für cnd_wait

Externe Links

The Old New Thing Artikel: Falsche Aufweckvorgänge in Win32-Bedingungsvariablen.