Namespaces
Variants
Actions

std::jthread::join

From cppreference.com
< cpp‎ | thread‎ | jthread
 
 
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
 
 
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 *thissynchronizes 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

[edit]Example

#include <chrono>#include <iostream>#include <thread>   void foo(){// simulate expensive operationstd::this_thread::sleep_for(std::chrono::seconds(1));}   void bar(){// simulate expensive operationstd::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

permits the thread to execute independently from the thread handle
(public member function)[edit]
checks whether the thread is joinable, i.e. potentially running in parallel context
(public member function)[edit]
C documentation for thrd_join
close