std::jthread(3)

NAME
std::jthread - A thread that can be requested to stop and automatically joined.

SYNOPSIS

  Public Types
using id = thread::id
using native_handle_type = thread::native_handle_type

  Public Member Functions
template<typename _Callable , typename... _Args, typename = enable_if_t<!is_same_v<remove_cvref_t<_Callable>, jthread>>> jthread (_Callable &&__f, _Args &&... __args)
jthread (const jthread &)=delete
jthread (jthread &&) noexcept=default
void detach ()
id get_id () const noexcept
stop_source get_stop_source () noexcept
stop_token get_stop_token () const noexcept
void join ()
bool joinable () const noexcept
native_handle_type native_handle ()
jthread & operator= (const jthread &)=delete
jthread & operator= (jthread &&__other) noexcept
bool request_stop () noexcept
void swap (jthread &__other) noexcept

  Static Public Member Functions
static unsigned hardware_concurrency () noexcept

  Friends
void swap (jthread &__lhs, jthread &__rhs) noexcept

Detailed Description

A thread that can be requested to stop and automatically joined.

Definition at line 113 of file thread.

Member Typedef Documentation

  using std::jthread::id = thread::id

Definition at line 116 of file thread.

  using std::jthread::native_handle_type = thread::native_handle_type

Definition at line 117 of file thread.

Constructor & Destructor Documentation

  std::jthread::jthread () [inline], [noexcept]

Definition at line 119 of file thread.

  template<typename _Callable , typename... _Args, typename = enable_if_t<!is_same_v<remove_cvref_t<_Callable>, jthread>>> std::jthread::jthread (_Callable && __f, _Args &&... __args) [inline], [explicit]

Definition at line 127 of file thread.

  std::jthread::~jthread () [inline]

Definition at line 135 of file thread.

Member Function Documentation

  void std::jthread::detach () [inline]

Definition at line 174 of file thread.

  id std::jthread::get_id () const [inline], [noexcept]

Definition at line 180 of file thread.

  stop_source std::jthread::get_stop_source () [inline], [noexcept]

Definition at line 198 of file thread.

  stop_token std::jthread::get_stop_token () const [inline], [noexcept]

Definition at line 204 of file thread.

  static unsigned std::jthread::hardware_concurrency () [inline], [static], [noexcept]

Definition at line 192 of file thread.

  void std::jthread::join () [inline]

Definition at line 168 of file thread.

  bool std::jthread::joinable () const [inline], [noexcept]

Definition at line 162 of file thread.

  native_handle_type std::jthread::native_handle () [inline]

Definition at line 186 of file thread.

  jthread & std::jthread::operator= (jthread && __other) [inline], [noexcept]

Definition at line 148 of file thread.

  bool std::jthread::request_stop () [inline], [noexcept]

Definition at line 209 of file thread.

  void std::jthread::swap (jthread & __other) [inline], [noexcept]

Definition at line 155 of file thread.

Friends And Related Function Documentation

  void swap (jthread & __lhs, jthread & __rhs) [friend]

Definition at line 214 of file thread.

Author

Generated automatically by Doxygen for libstdc++ from the source code.