class agent_ref

Declaration

class agent_ref { /* full declaration omitted */ };

Declared at: libs/pika/execution_base/include/pika/execution_base/agent_ref.hpp:20

Method Overview

• public void abort(const char * desc = "pika::execution_base::agent_ref::abort")
• public constexpr agent_ref() noexcept
• public constexpr agent_ref(pika::execution_base::agent_base * impl) noexcept
• public agent_ref(const pika::execution_base::agent_ref &) noexcept
• public agent_ref(pika::execution_base::agent_ref &&) noexcept
• public constexpr bool operator bool() const noexcept
• public pika::execution_base::agent_base & ref()
• public void reset(pika::execution_base::agent_base * impl = nullptr)
• public void resume(const char * desc = "pika::execution_base::agent_ref::resume")
• public template <typename Rep, typename Period>void sleep_for(const std::chrono::duration<Rep, Period> & sleep_duration, const char * desc = "pika::execution_base::agent_ref::sleep_for")
• public template <typename Clock, typename Duration>void sleep_until(const std::chrono::time_point<Clock, Duration> & sleep_time, const char * desc = "pika::execution_base::agent_ref::sleep_until")
• public void suspend(const char * desc = "pika::execution_base::agent_ref::suspend")
• public void yield(const char * desc = "pika::execution_base::agent_ref::yield")
• public void yield_k(std::size_t k, const char * desc = "pika::execution_base::agent_ref::yield_k")

Methods

void abort(
    const char* desc =
        "pika::execution_base::agent_ref::abort")

Declared at: libs/pika/execution_base/include/pika/execution_base/agent_ref.hpp:55

Parameters

const char* desc = "pika::execution_base::agent_ref::abort"

constexpr agent_ref() noexcept

Declared at: libs/pika/execution_base/include/pika/execution_base/agent_ref.hpp:23

constexpr agent_ref(
    pika::execution_base::agent_base*
        impl) noexcept

Declared at: libs/pika/execution_base/include/pika/execution_base/agent_ref.hpp:27

Parameters

pika::execution_base::agent_base* impl

agent_ref(const pika::execution_base::
              agent_ref&) noexcept

Declared at: libs/pika/execution_base/include/pika/execution_base/agent_ref.hpp:32

Parameters

const pika::execution_base::agent_ref&

agent_ref(
    pika::execution_base::agent_ref&&) noexcept

Declared at: libs/pika/execution_base/include/pika/execution_base/agent_ref.hpp:35

Parameters

pika::execution_base::agent_ref&&

constexpr bool operator bool() const noexcept

Declared at: libs/pika/execution_base/include/pika/execution_base/agent_ref.hpp:38

pika::execution_base::agent_base& ref()

Declared at: libs/pika/execution_base/include/pika/execution_base/agent_ref.hpp:72

void reset(pika::execution_base::agent_base*
               impl = nullptr)

Declared at: libs/pika/execution_base/include/pika/execution_base/agent_ref.hpp:43

Parameters

pika::execution_base::agent_base* impl = nullptr

void resume(
    const char* desc =
        "pika::execution_base::agent_ref::resume")

Declared at: libs/pika/execution_base/include/pika/execution_base/agent_ref.hpp:53

Parameters

const char* desc = "pika::execution_base::agent_ref::resume"

template <typename Rep, typename Period>
void sleep_for(
    const std::chrono::duration<Rep, Period>&
        sleep_duration,
    const char* desc =
        "pika::execution_base::agent_ref::sleep_"
        "for")

Declared at: libs/pika/execution_base/include/pika/execution_base/agent_ref.hpp:58

Parameters

const std::chrono::duration<Rep, Period>& sleep_duration

const char* desc = "pika::execution_base::agent_ref::sleep_for"

template <typename Clock, typename Duration>
void sleep_until(const std::chrono::time_point<
                     Clock,
                     Duration>& sleep_time,
                 const char* desc =
                     "pika::execution_base::"
                     "agent_ref::sleep_until")

Declared at: libs/pika/execution_base/include/pika/execution_base/agent_ref.hpp:65

Parameters

const std::chrono::time_point<Clock, Duration>& sleep_time

const char* desc = "pika::execution_base::agent_ref::sleep_until"

void suspend(const char* desc =
                 "pika::execution_base::agent_"
                 "ref::suspend")

Declared at: libs/pika/execution_base/include/pika/execution_base/agent_ref.hpp:51

Parameters

const char* desc = "pika::execution_base::agent_ref::suspend"

void yield(
    const char* desc =
        "pika::execution_base::agent_ref::yield")

Declared at: libs/pika/execution_base/include/pika/execution_base/agent_ref.hpp:48

Parameters

const char* desc = "pika::execution_base::agent_ref::yield"

void yield_k(std::size_t k,
             const char* desc =
                 "pika::execution_base::agent_"
                 "ref::yield_k")

Declared at: libs/pika/execution_base/include/pika/execution_base/agent_ref.hpp:49

Parameters

std::size_t k

const char* desc = "pika::execution_base::agent_ref::yield_k"