std::jthread::get_id(3)

πŸ“¦ version 2024.07.05, in nixpkgs unstable, opensuse-leap 16.0

πŸ’– std::jthread::get_id(3) πŸ’–

okay so welcome to the std::jthread::get_id(3) page from the C++ Standard Libary manual, bestie. this one is short, it’s giving β€œtiny but mighty,” and we’re gonna get you all the way together. πŸ’…


🌸 NAME 🌸

std::jthread::get_id β€” literally std::jthread::get_id, no cap. that’s the whole name, and she ate.

✨ Synopsis ✨

here’s the signature, bestie β€” copy it exactly, [[nodiscard]] and all:

[[nodiscard]] std::jthread::id get_id() const noexcept;

(since C++20)

so yeah: it returns a value of std::jthread::id β€” which is a type alias for std::thread::id β€” identifying the thread associated with *this. iykyk. πŸ¦‹

πŸŽ€ Parameters πŸŽ€

none. (none). zero. no arguments, no drama. πŸ™ˆ

πŸ’œ Return value πŸ’œ

a value of type std::jthread::id identifying the thread associated with *this. if there is no thread associated, a default constructed std::jthread::id is returned. that’s the whole tea. πŸ“

πŸ”₯ Example πŸ”₯

// Run this code β€” here’s the example, verbatim:

#include <chrono>
#include <iostream>
#include <thread>

void foo()
{
    std::this_thread::sleep_for(std::chrono::seconds(1));
}

int main()
{
    std::jthread t1(foo);
    std::jthread::id t1_id = t1.get_id();

    std::jthread t2(foo);
    std::jthread::id t2_id = t2.get_id();

    std::cout << "t1's id: " << t1_id << '\n';
    std::cout << "t2's id: " << t2_id << '\n';

    t1.join();
    t2.join();

    std::cout << "t1's id after join: " << t1.get_id() << '\n';
    std::cout << "t2's id after join: " << t2.get_id() << '\n';
}

Possible output:

t1's id: 140146221688576
t2's id: 140146213295872
t1's id after join: thread::id of a non-executing thread
t2's id after join: thread::id of a non-executing thread

🌈 See also 🌈

  • id β€” represents the id of a thread (public member class of std::thread)
  • checks whether the thread is joinable, i.e. potentially running in parallel
  • joinable context β€” (public member function)

mwah πŸ’‹ sign-off time: source/version: http://cppreference.com; date/version: 2024.06.10; page: std::jthread::get_id(3). periodt. πŸ‘‘

πŸ“¦ where this page comes from