std::execution::run_loop::finish

 

C++

Compiler support

Freestanding and hosted

Language

Standard library

Standard library headers

Named requirements

Feature test macros (C++20)

Language support library

Concepts library (C++20)

Diagnostics library

Memory management library

Metaprogramming library (C++11)

General utilities library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Strings library

Text processing library

Numerics library

Date and time library

Input/output library

Filesystem library (C++17)

Concurrency support library (C++11)

Execution control library (C++26)

Technical specifications

Symbols index

External libraries

 

Execution control library

Execution concepts scheduler receiver operation_state      scope_token sender sender_in dependent_sender scope_association        Execution components Execution contexts run_loop Execution domains default_domain transform_sender      apply_sender Forward progress guarantee forward_progress_guarantee Environments env      prop      get_env      env_of_t Queries std::stop_token_of_t std::get_stop_token std::get_allocator std::forwarding_query get_scheduler get_domain get_completion_domain get_forward_progress_guarantee get_start_scheduler get_delegation_scheduler get_completion_scheduler get_await_completion_adaptor Completion signatures completion_signatures completion_signatures_of_t value_types_of_t error_types_of_t      tag_of_t sends_stopped Sender adaptor closures sender_adaptor_closure Coroutine utility as_awaitable with_awaitable_senders affine inline_scheduler task task_scheduler

Core operations Operation state connect connect_result_t start Completion set_value      set_error      set_stopped Sender algorithms Sender factories just just_error just_stopped read_env schedule schedule_result_t Sender adaptors starts_on continues_on on schedule_from      then upon_error upon_stopped let_value let_error let_stopped when_all when_all_with_variant into_variant stopped_as_optional stopped_as_error bulk write_env unstoppable associate spawn_future Sender consumers this_thread::sync_wait this_thread::sync_wait_with_variant spawn Asynchronous scopes simple_counting_scope counting_scope Parallel scheduler parallel_scheduler get_parallel_scheduler receiver_proxy bulk_item_receiver_proxy parallel_scheduler_backend query_parallel_scheduler_backend

 

std::execution::run_loop

Member functions

run_loop::run_loop

run_loop::~run_loop

run_loop::get_scheduler

run_loop::run

run_loop::finish

 

void finish() noexcept;		(since C++26)

Requests the run_loop to finish.

Preconditions

The run_loop instance's state is either starting or running.

Effects

Changes the run_loop instance's state to finishing.

If a thread is blocked in run waiting for work, finish lets that call return once the queue is empty.

Synchronization

finish synchronizes with the internal pop-front operation that returns nullptr to run.

Notes

Calling finish does not discard already queued work. A run call continues to execute queued operation states until the queue becomes empty, then returns.

It is valid to call finish before run. In that case, a later call to run observes the finishing state and returns once it sees the empty queue.