boost::capy::thread_pool::executor_type

An executor that submits work to a thread_pool.

Synopsis

class executor_type;

Description

Executors are lightweight handles that can be copied and stored. All copies refer to the same underlying thread pool.

Thread Safety

Distinct objects: Safe. Shared objects: Safe.

Member Functions

Name

Description

executor_type [constructor]

Default construct a null executor.

context

Return the underlying thread pool.

dispatch

Dispatch a coroutine for execution.

on_work_finished

Notify that work has finished (no‐op for thread pools).

on_work_started

Notify that work has started (no‐op for thread pools).

post

Post a coroutine to the thread pool.

operator==

Return true if two executors refer to the same thread pool.

Friends

Name Description

boost::capy::thread_pool

A pool of threads for executing work concurrently.

Created with MrDocs