Movatterモバイル変換


[0]ホーム

URL:


cppreference.com
Namespaces
Variants
    Actions

      Execution control library(since C++26)

      From cppreference.com
      <cpp
       
       
      Execution control library
       

      The Execution control library provides a framework for managing asynchronous execution on generic execution resources.

      The library aims to provide vocabulary types for asynchronous operations and to allow the construction of task execution graphs in a simple, composable way.

      Contents

      [edit]Library-wide definitions

      • Sender: A description of asynchronous work to be sent for execution. Produces an operation state (below).
      • Senders asynchronously “send” their results to listeners called “receivers” (below).
      • Senders can be composed intotask graphs using generic algorithms.
      • Sender factories and adaptors are generic algorithms that capture common async patterns in objects satisfying thesender concept.
      • Receiver: A generalized callback that consumes or “receives” the asynchronous results produced by a sender.
      • Receivers have three different “channels” through which a sender may propagate results: success, failure, and canceled, so-named “value”, “error”, and “stopped”.
      • Receivers provide an extensible execution environment: a set of key/value pairs that the consumer can use to parameterize the asynchronous operation.
      • Operation State: An object that contains the state needed by the asynchronous operation.
      • A sender and receiver are connected when passed to thestd::execution::connect function.
      • The result of connecting a sender and a receiver is an operation state.
      • Work is not enqueued for execution until “start” is called on an operation state.
      • Once started, the operation state’s lifetime cannot end before the async operation is complete, and its address must be stable.
      • Scheduler: A lightweight handle to an execution context.
      • An execution context is a source of asynchronous execution such as a thread pool or a GPU stream.
      • A scheduler is a factory for a sender that completes its receiver from a thread of execution owned by the execution context.

      [edit]Library utilities

      [edit]Concepts

      [edit]Schedulers

      Defined in header<execution>
      Defined in namespacestd::execution
      specifies that a type is a scheduler
      (concept)[edit]

      [edit]Senders

      Defined in header<execution>
      Defined in namespacestd::execution
      specifies that a type is a sender
      (concept)[edit]
      specifies a sender that can create asynchronous operations for given associated environment type
      (concept)[edit]
      specifies a sender that can connect with a specific receiver type
      (concept)[edit]

      [edit]Receivers

      Defined in header<execution>
      Defined in namespacestd::execution
      specifies that a type is a receiver
      (concept)[edit]
      specifies that a type is a receiver for given completion signatures
      (concept)[edit]

      [edit]Operation states

      Defined in header<execution>
      Defined in namespacestd::execution
      specifies that a type is an operation state
      (concept)[edit]

      [edit]Utility components

      [edit]Execution contexts

      Defined in header<execution>
      Defined in namespacestd::execution
      execution resource holding a thread-safeMPSC task queue and a manually-driven event loop
      (class)[edit]

      [edit]Execution domains

      Defined in header<execution>
      Defined in namespacestd::execution
      default execution domain tag type that dispatches transformations from a sender tag
      (class)[edit]
      transforms into a new sender under a given execution domain tag
      (function template)[edit]
      transforms into a new queryable object under a given execution domain tag
      (function template)[edit]
      consumes a sender using a given sender consumer tag with a set of arguments and returns its result under a given execution domain tag
      (function template)[edit]

      [edit]Forward progress guarantee

      Defined in header<execution>
      Defined in namespacestd::execution
      specifies aforward progress guarantee of execution agents created by the scheduler's associated execution resource
      (enum)[edit]

      [edit]Environments

      Defined in header<execution>
      Defined in namespacestd::execution
      builds a queryable object from a query object and a value
      (class template)[edit]
      aggregates several queryable objects into one queryable object
      (class template)[edit]
      returns the associated queryable object for its given argument
      (customization point object)[edit]

      [edit]Queries

      Defined in header<execution>
      asks a query object whether it should be forwarded through queryable adaptors
      (customization point object)[edit]
      asks a queryable object for its associated allocator
      (customization point object)[edit]
      asks a queryable object for its associated stop token
      (customization point object)[edit]
      asks a queryable object for its associated execution domain tag
      (customization point object)[edit]
      asks a queryable object for its associated scheduler
      (customization point object)[edit]
      asks a queryable object for a scheduler that can be used to delegate work to for the purpose of forward progress delegation
      (customization point object)[edit]
      obtains the completion scheduler associated with a completion tag from a sender's attributes
      (customization point object)[edit]
      asks a scheduler about itsexecution::forward_progress_guarantee
      (customization point object)[edit]

      [edit]Completion signatures

      Defined in header<execution>
      Defined in namespacestd::execution
      type that encodes a set of completion signatures
      (class template)[edit]
      obtains the completion signatures of a sender
      (customization point object)[edit]
      transforms one set of completion signatures into another
      (alias template)[edit]
      transforms completion signatures of a sender
      (alias template)[edit]
      obtains the tag type of a sender
      (alias template)[edit]
      obtains the value completion type of a sender
      (alias template)[edit]
      obtains the error completion type of a sender
      (alias template)[edit]
      determines whether the sender supports stopped completion
      (variable template)[edit]

      [edit]Coroutine utility

      Defined in header<execution>
      Defined in namespacestd::execution
      transforms an expression into awaitable object within a particular coroutine
      (customization point object)[edit]
      when used as the base class of a coroutine promise type, enables senders to be awaitable within that coroutine type
      (class template)[edit]

      [edit]Core operations

      [edit]Operation state

      Defined in header<execution>
      Defined in namespacestd::execution
      connects asender with areceiver
      (customization point object)[edit]
      starts the asynchronous operation associated with anoperation_state object
      (customization point object)[edit]

      [edit]Completion functions

      These functions are called by senders to announce the completion of the work to their receivers.

      Defined in header<execution>
      Defined in namespacestd::execution
      value completion function indicating successful completion
      (customization point object)[edit]
      error completion function indicating that an error occurred during calculation or scheduling
      (customization point object)[edit]
      stopped completion function indicating that an operation ended before it could achieve success or failure
      (customization point object)[edit]

      [edit]Sender algorithms

      This section is incomplete
      Reason: WIP update to current standard in progress

      [edit]Sender factories

      A sender factory is a function that returns a sender and whose parameters have types for which thesender concept isfalse.

      The following are sender factories:

      Defined in header<execution>
      Defined in namespacestd::execution
      Accepts a variadic number of arguments and returns a sender that, when connected and started, completes synchronously by passing the arguments to the receiver's value completion function
      (customization point object)[edit]
      Accepts a single argument and returns a sender that, when connected and started, completes synchronously by passing the argument to the receiver's error completion function
      (customization point object)[edit]
      creates a sender that completes immediately by calling its receiver'sset_stopped
      (customization point object)[edit]
      creates a sender that queries its receiver's associated environment
      (customization point object)[edit]
      prepares a task graph for execution on a given scheduler
      (customization point object)[edit]

      [edit]Pipeable sender adaptors

      Defined in header<execution>
      Defined in namespacestd::execution
      helper base class template for defining a pipeable sender adaptor closure object
      (class template)[edit]

      [edit]Sender adaptors

      A sender adaptor is a function returning a sender whose parameters include at least one whose type satisfies thesender concept, and for which the returned sender is a parent sender of the adaptor function's sender arguments.

      The following are sender adaptors:

      Defined in header<execution>
      Defined in namespacestd::execution
      adapts a provided sender into one that will start an execution on the provided scheduler's execution resource
      (customization point object)[edit]
      adapts a provided sender into one that completes on the provided scheduler's execution resource
      (customization point object)[edit]
      adapts a provided sender to transfer execution to a provided scheduler's execution resource on which the sender or the continuation runs, and then transfers execution back to the original resource
      (customization point object)[edit]
      schedules work dependent on the completion of a provided sender onto a provided scheduler's execution resource
      (customization point object)[edit]
      chains the task graph by the input sender with a node represents invoking the provided function with the values sent by the input sender as arguments
      (customization point object)[edit]
      chains the task graph by the input sender with a node representing invoking the provided function with the error sent by the input sender if an error occurred
      (customization point object)[edit]
      chains the task graph by the input sender with a node representing invoking the provided function with the stopped behavior by the input sender if a "stopped" signal is sent
      (customization point object)[edit]
      returns a sender which represents a node chained to the input sender, which when started, invokes the provided function with the values sent by the input sender as arguments
      (customization point object)[edit]
      returns a sender which represents a node chained to the input sender, which invokes the provided function with the error from the input sender, if occurred
      (customization point object)[edit]
      returns a sender which represents a node chained to the input sender, which invokes the provided function with the stop token from the input sender, if the "stopped" signal is sent
      (customization point object)[edit]
      creates a multi-shot sender that invokes the function with every index in the provided shape along with the values sent by the input sender. The sender completes once all invocations have completed, or an error has occurred
      (customization point object)[edit]
      if the provided sender is a multi-shot sender, returns that sender, otherwise, returns a multi-shot sender which sends values equivalent to the values sent by the provided sender
      (customization point object)[edit]
      adapts multiple input senders into a sender that completes once all of the input senders have completed
      (customization point object)[edit]
      adapts multiple input senders, with each possibly having multiple completion signatures, into a sender that completes once all of the input senders have completed
      (customization point object)[edit]
      returns a sender which sends a variant of tuples of all the possible sets of types sent by the input sender
      (customization point object)[edit]
      returns a sender that maps the value channel tostd::optional<std::decay_t<T>> and the stopped channel tostd::nullopt
      (customization point object)[edit]
      returns a sender that maps the stopped channel to an error
      (customization point object)[edit]

      [edit]Sender consumers

      A sender consumer is an algorithm that takes one or more senders as parameters and that does not return a sender.

      Defined in header<execution>
      Defined in namespacestd::this_thread
      blocks current thread until the specified sender completes and returns its async result
      (customization point object)[edit]
      blocks current thread until the specified sender with possibly multiple completion signatures completes and returns its async result
      (customization point object)[edit]

      [edit]Example

      A version of this example is available ongodbolt.org, where it usesstdexec, an experimental reference implementation ofstd::execution.

      Run this code
      #include <cstdio>#include <execution>#include <string>#include <thread>#include <utility>usingnamespace std::literals; int main(){    std::execution::run_loop loop; std::jthread worker([&](std::stop_token st){std::stop_callback cb{st,[&]{ loop.finish();}};        loop.run();});     std::execution::senderauto hello= std::execution::just("hello world"s);    std::execution::senderauto print= std::move(hello)| std::execution::then([](std::string msg){returnstd::puts(msg.c_str());});     std::execution::schedulerauto io_thread= loop.get_scheduler();    std::execution::senderauto work= std::execution::on(io_thread, std::move(print)); auto[result]= std::this_thread::sync_wait(std::move(work)).value(); return result;}

      Output:

      hello world

      [edit]See also

      (C++11)
      runs a function asynchronously (potentially in a new thread) and returns astd::future that will hold the result
      (function template)[edit]
      Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/execution&oldid=181104"

      [8]ページ先頭

      ©2009-2025 Movatter.jp