std::jthread::join
From cppreference.com
C++
Feature test macros (C++20)
Concepts library (C++20)
Metaprogramming library (C++11)
Ranges library (C++20)
Filesystem library (C++17)
Concurrency support library (C++11)
Execution control library (C++26)
Concurrency support library
(C++11)
(C++20)
(C++11)
(C++11)
(C++20)
(C++26)
(C++26)
(C++20)
(C++26)
(C++20)
(C++26)
(C++26)
(C++26)
(C++26)
(C++26)
(C++26)
(C++11)
(C++11)
(C++17)
(C++11)
(C++14)
(C++11)
(C++11)
(C++11)
(C++11)(C++11)(C++11)(C++11)(C++11)(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++20)(C++20)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++26)
(C++26)
(C++26)
(C++11)
(C++20)
(C++11)
(C++11)(deprecated in C++20)
(C++11)(deprecated in C++20)
(C++11)
(C++11)
(C++11)(deprecated in C++26)
(C++11)
(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++26)(C++26)
(C++26)(C++26)
(C++11)
(C++20)(C++20)
(C++20)
(C++20)
(C++11)(C++11)
(C++11)(C++11)
(C++20)(C++20)
(C++20)(C++20)
(C++20)
(C++20)
std::jthread
Member functions
Observers
Operations
jthread::join
Stop token handling
Non-member functions
void join();
(since C++20)
Blocks the current thread until the thread identified by *this finishes its execution.
The completion of the thread identified by *this synchronizes with the corresponding successful return from join().
No synchronization is performed on *this itself. Concurrently calling join() on the same jthread object from multiple threads constitutes a data race that results in undefined behavior.
Contents
[edit] Parameters
(none)
[edit] Return value
(none)
[edit] Postconditions
joinable() is false.
[edit] Exceptions
std::system_error if an error occurs.
[edit] Error conditions
- resource_deadlock_would_occur if this->get_id() == std::this_thread::get_id () (deadlock detected).
- no_such_process if the thread is not valid.
- invalid_argument if joinable() is false.
[edit] Example
Run this code
#include <chrono> #include <iostream> #include <thread> void foo() { // simulate expensive operation std::this_thread::sleep_for (std::chrono::seconds (1)); } void bar() { // simulate expensive operation std::this_thread::sleep_for (std::chrono::seconds (1)); } int main() { std::cout << "starting first helper...\n"; std::jthread helper1(foo); std::cout << "starting second helper...\n"; std::jthread helper2(bar); std::cout << "waiting for helpers to finish..." << std::endl ; helper1.join(); helper2.join(); std::cout << "done!\n"; }
Output:
starting first helper... starting second helper... waiting for helpers to finish... done!
[edit] References
- C++23 standard (ISO/IEC 14882:2024):
- 33.4.4.3 Members [thread.jthread.mem]
- C++20 standard (ISO/IEC 14882:2020):
- 32.4.3.2 Members [thread.jthread.mem]
[edit] See also
checks whether the thread is joinable, i.e. potentially running in parallel context
(public member function) [edit]
(public member function) [edit]
C documentation for thrd_join