Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. — Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is the documentation for an old version of Boost. Click here to view this page for the latest version.

thread_pool::basic_executor_type

Executor implementation type used to submit functions to a thread pool.

template<
    typename Allocator,
    unsigned int Bits>
class basic_executor_type

Types

Name	Description
index_type	The bulk execution index type.
sender_type	The sender type, when this type is used as a scheduler.
shape_type	The bulk execution shape type.

Member Functions

Name	Description
basic_executor_type [constructor]	Copy constructor. — Move constructor.
bulk_execute	Bulk execution function.
connect	Connect function.
context	Obtain the underlying execution context.
defer	Request the thread pool to invoke the given function object.
dispatch	Request the thread pool to invoke the given function object.
execute	Execution function.
on_work_finished	Inform the thread pool that some work is no longer outstanding.
on_work_started	Inform the thread pool that it has some outstanding work to do.
operator=	Assignment operator. — Move assignment operator.
post	Request the thread pool to invoke the given function object.
query	Query the current value of the context property. — Query the current value of the blocking property. — Query the current value of the relationship property. — Query the current value of the allocator property. — Query the occupancy (recommended number of work items) for the pool.
query [static]	Query the current value of the bulk_guarantee property. — Query the current value of the mapping property. — Query the current value of the outstanding_work property.
require	Obtain an executor with the blocking.possibly property. — Obtain an executor with the blocking.always property. — Obtain an executor with the blocking.never property. — Obtain an executor with the relationship.fork property. — Obtain an executor with the relationship.continuation property. — Obtain an executor with the outstanding_work.tracked property. — Obtain an executor with the outstanding_work.untracked property. — Obtain an executor with the specified allocator property. — Obtain an executor with the default allocator property.
running_in_this_thread	Determine whether the thread pool is running in the current thread.
schedule	Schedule function.
~basic_executor_type [destructor]	Destructor.

Friends

Name	Description
operator!=	Compare two executors for inequality.
operator==	Compare two executors for equality.

Requirements

Header: boost/asio/thread_pool.hpp

Convenience header: boost/asio.hpp