struct future_data_base

Declaration

template <typename Result>
struct future_data_base : public future_data_base { /* full declaration omitted */ };

Description

////////////////////////////////////////////////////////////////////////

Declared at: libs/pika/futures/include/pika/futures/detail/future_data.hpp:337

Inherits from: future_data_base

Method Overview

Methods

future_data_base<Result>()

Declared at: libs/pika/futures/include/pika/futures/detail/future_data.hpp:366

future_data_base<Result>(
    pika::lcos::detail::future_data_base::
        init_no_addref no_addref) noexcept

Declared at: libs/pika/futures/include/pika/futures/detail/future_data.hpp:368

Parameters

pika::lcos::detail::future_data_base:: init_no_addref no_addref

future_data_base<Result>(
    pika::lcos::detail::future_data_base::
        init_no_addref no_addref,
    const std::exception_ptr& e)

Declared at: libs/pika/futures/include/pika/futures/detail/future_data.hpp:382

Parameters

pika::lcos::detail::future_data_base:: init_no_addref no_addref
const std::exception_ptr& e

future_data_base<Result>(
    pika::lcos::detail::future_data_base::
        init_no_addref no_addref,
    std::exception_ptr&& e)

Declared at: libs/pika/futures/include/pika/futures/detail/future_data.hpp:390

Parameters

pika::lcos::detail::future_data_base:: init_no_addref no_addref
std::exception_ptr&& e

template <typename... Ts>
future_data_base<Result>(
    pika::lcos::detail::future_data_base::
        init_no_addref no_addref,
    pika::lcos::detail::in_place,
    Ts&&... ts)

Declared at: libs/pika/futures/include/pika/futures/detail/future_data.hpp:374

Parameters

pika::lcos::detail::future_data_base:: init_no_addref no_addref
pika::lcos::detail::in_place
Ts&&... ts

std::exception_ptr get_exception_ptr() const

Declared at: libs/pika/futures/include/pika/futures/detail/future_data.hpp:621

virtual pika::lcos::detail::future_data_base::
    result_type*
    get_result(pika::error_code& ec = throws)

Description

Get the result of the requested action. This call blocks (yields control) if the result is not ready. As soon as the result has been returned and the waiting thread has been re-scheduled by the thread manager the function will return.

Declared at: libs/pika/futures/include/pika/futures/detail/future_data.hpp:420

Parameters

pika::error_code& ec = throws
[in,out] this represents the error status on exit, if this is pre-initialized to \athe function will throw on error instead. If the operation blocks and is aborted because the object went out of scope, the code \ais set or thrown.

util::unused_type* get_result_void(
    pika::error_code& ec = throws)

Declared at: libs/pika/futures/include/pika/futures/detail/future_data.hpp:429

Parameters

pika::error_code& ec = throws

void reset(pika::error_code& = throws)

Description

Reset the promise to allow to restart an asynchronous operation. Allows any subsequent set_data operation to succeed.

Declared at: libs/pika/futures/include/pika/futures/detail/future_data.hpp:592

Parameters

pika::error_code& = throws

template <typename T>
void set_data(T&& result)

Declared at: libs/pika/futures/include/pika/futures/detail/future_data.hpp:556

Parameters

T&& result

void set_error(pika::error e,
               const char* f,
               const char* msg)

Declared at: libs/pika/futures/include/pika/futures/detail/future_data.hpp:583

Parameters

pika::error e
const char* f
const char* msg

void set_exception(std::exception_ptr data)

Declared at: libs/pika/futures/include/pika/futures/detail/future_data.hpp:494

Parameters

std::exception_ptr data

template <typename T>
void set_remote_data(T&& result)

Declared at: libs/pika/futures/include/pika/futures/detail/future_data.hpp:566

Parameters

T&& result

template <typename... Ts>
void set_value(Ts&&... ts)

Declared at: libs/pika/futures/include/pika/futures/detail/future_data.hpp:436

Parameters

Ts&&... ts

~future_data_base<Result>() noexcept

Description

////////////////////////////////////////////////////////////////////////

Declared at: libs/pika/futures/include/pika/futures/detail/future_data.hpp:399