struct launch

Declaration

struct launch : public policy_holder { /* full declaration omitted */ };

Description

//////////////////////////////////////////////////////////////////////// Launch policies for \aetc.

Declared at: libs/pika/async_base/include/pika/async_base/launch_policy.hpp:705

Inherits from: policy_holder

Member Variables

public static const detail::async_policy async
//////////////////////////////////////////////////////////////////// Predefined launch policy representing asynchronous execution
public static const detail::fork_policy fork
Predefined launch policy representing asynchronous execution.The new thread is executed in a preferred way
public static const detail::sync_policy sync
Predefined launch policy representing synchronous execution
public static const detail::deferred_policy deferred
Predefined launch policy representing deferred execution
public static const detail::apply_policy apply
Predefined launch policy representing fire and forget execution
public static const detail::select_policy_generator select
Predefined launch policy representing delayed policy selection
public static const detail::policy_holder<> all
\condNOINTERNAL
public static const detail::policy_holder<> sync_policies
public static const detail::policy_holder<> async_policies

Method Overview

  • public constexpr launch() noexcept
  • public constexpr launch(const detail::policy_holder_base & ph) noexcept
  • public constexpr launch(detail::async_policy p) noexcept
  • public constexpr launch(detail::fork_policy p) noexcept
  • public constexpr launch(detail::sync_policy p) noexcept
  • public constexpr launch(detail::deferred_policy p) noexcept
  • public constexpr launch(detail::apply_policy p) noexcept
  • public template <typename Derived>constexpr launch(const detail::policy_holder<Derived> & ph) noexcept
  • public template <typename F>constexpr launch(const detail::select_policy<F> & p) noexcept
  • public template <typename Launch, typename Enable = std::enable_if_t<pika::detail::is_launch_policy_v<Launch>>>constexpr launch(Launch l, threads::thread_priority priority, threads::thread_stacksize stacksize, threads::thread_schedule_hint hint) noexcept

Methods

constexpr launch() noexcept

Description

//////////////////////////////////////////////////////////////////// Default constructor. This creates a launch policy representing all possible launch modes

Declared at: libs/pika/async_base/include/pika/async_base/launch_policy.hpp:710

constexpr launch(
    const detail::policy_holder_base& ph) noexcept

Declared at: libs/pika/async_base/include/pika/async_base/launch_policy.hpp:722

Parameters

const detail::policy_holder_base& ph

constexpr launch(detail::async_policy p) noexcept

Description

Create a launch policy representing asynchronous execution

Declared at: libs/pika/async_base/include/pika/async_base/launch_policy.hpp:729

Parameters

detail::async_policy p

constexpr launch(detail::fork_policy p) noexcept

Description

Create a launch policy representing asynchronous execution. The new thread is executed in a preferred way

Declared at: libs/pika/async_base/include/pika/async_base/launch_policy.hpp:737

Parameters

detail::fork_policy p

constexpr launch(detail::sync_policy p) noexcept

Description

Create a launch policy representing synchronous execution

Declared at: libs/pika/async_base/include/pika/async_base/launch_policy.hpp:744

Parameters

detail::sync_policy p

constexpr launch(
    detail::deferred_policy p) noexcept

Description

Create a launch policy representing deferred execution

Declared at: libs/pika/async_base/include/pika/async_base/launch_policy.hpp:751

Parameters

detail::deferred_policy p

constexpr launch(detail::apply_policy p) noexcept

Description

Create a launch policy representing fire and forget execution

Declared at: libs/pika/async_base/include/pika/async_base/launch_policy.hpp:758

Parameters

detail::apply_policy p

template <typename Derived>
constexpr launch(
    const detail::policy_holder<Derived>&
        ph) noexcept

Description

\condNOINTERNAL

Declared at: libs/pika/async_base/include/pika/async_base/launch_policy.hpp:717

Parameters

const detail::policy_holder<Derived>& ph

template <typename F>
constexpr launch(
    const detail::select_policy<F>& p) noexcept

Description

Create a launch policy representing fire and forget execution

Declared at: libs/pika/async_base/include/pika/async_base/launch_policy.hpp:766

Parameters

const detail::select_policy<F>& p

template <
    typename Launch,
    typename Enable = std::enable_if_t<
        pika::detail::is_launch_policy_v<Launch>>>
constexpr launch(
    Launch l,
    threads::thread_priority priority,
    threads::thread_stacksize stacksize,
    threads::thread_schedule_hint hint) noexcept

Declared at: libs/pika/async_base/include/pika/async_base/launch_policy.hpp:775

Parameters

Launch l
threads::thread_priority priority
threads::thread_stacksize stacksize
threads::thread_schedule_hint hint