class promise_base

Declaration

template <typename R,
          typename SharedState = lcos::detail::future_data<R>>
class promise_base { /* full declaration omitted */ };

Declared at: libs/pika/futures/include/pika/futures/promise.hpp:29

Member Variables

protected pika::intrusive_ptr<shared_state_type> shared_state_

protected bool future_retrieved_

protected bool shared_future_retrieved_

Method Overview

• protected void check_abandon_shared_state(const char * fun)
• public pika::future<R> get_future(pika::error_code & ec = throws)
• public pika::shared_future<R> get_shared_future(pika::error_code & ec = throws)
• public promise_base<R, SharedState>()
• public promise_base<R, SharedState>(promise_base<R, SharedState> && other) noexcept
• public template <typename Allocator> promise_base<R, SharedState>(std::allocator_arg_t, const Allocator & a)
• public template <typename T>void set_exception(T && value)
• public template <typename... Ts>typename std::enable_if<std::is_constructible<R, Ts &&...>::value || std::is_void<R>::value>::type set_value(Ts &&... ts)
• public void swap(promise_base<R, SharedState> & other) noexcept
• public bool valid() const noexcept
• public ~promise_base<R, SharedState>()

Methods

void check_abandon_shared_state(const char* fun)

Declared at: libs/pika/futures/include/pika/futures/promise.hpp:211

Parameters

const char* fun

pika::future<R> get_future(
    pika::error_code& ec = throws)

Declared at: libs/pika/futures/include/pika/futures/promise.hpp:117

Parameters

pika::error_code& ec = throws

pika::shared_future<R> get_shared_future(
    pika::error_code& ec = throws)

Declared at: libs/pika/futures/include/pika/futures/promise.hpp:141

Parameters

pika::error_code& ec = throws

promise_base<R, SharedState>()

Declared at: libs/pika/futures/include/pika/futures/promise.hpp:35

promise_base<R, SharedState>(
    promise_base<R, SharedState>&& other) noexcept

Declared at: libs/pika/futures/include/pika/futures/promise.hpp:70

Parameters

promise_base<R, SharedState>&& other

template <typename Allocator>
promise_base<R, SharedState>(std::allocator_arg_t,
                             const Allocator& a)

Declared at: libs/pika/futures/include/pika/futures/promise.hpp:43

Parameters

std::allocator_arg_t

const Allocator& a

template <typename T>
void set_exception(T&& value)

Declared at: libs/pika/futures/include/pika/futures/promise.hpp:189

Parameters

T&& value

template <typename... Ts>
typename std::enable_if<
    std::is_constructible<R, Ts&&...>::value ||
    std::is_void<R>::value>::type
set_value(Ts&&... ts)

Declared at: libs/pika/futures/include/pika/futures/promise.hpp:167

Parameters

Ts&&... ts

void swap(
    promise_base<R, SharedState>& other) noexcept

Declared at: libs/pika/futures/include/pika/futures/promise.hpp:104

Parameters

promise_base<R, SharedState>& other

bool valid() const noexcept

Declared at: libs/pika/futures/include/pika/futures/promise.hpp:112

~promise_base<R, SharedState>()

Declared at: libs/pika/futures/include/pika/futures/promise.hpp:80