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 version of Boost is under active development. You are currently in the develop branch. The current version is 1.90.0.

inline_or_executor

inline_or_executor

Adapts an executor to add inline invocation of the submitted function.

template<
    typename Executor,
    typename Blocking = execution::blocking_t::always_t,
    typename InlineExceptionHandling = execution::inline_exception_handling_t::propagate_t>
class inline_or_executor

Types

Name	Description
inner_executor_type	The type of the underlying executor.

Member Functions

Name	Description
context	Obtain the underlying execution context.
defer	Request the inline_or_executor to invoke the given function object.
dispatch	Request the inline_or_executor to invoke the given function object.
execute	Request the inline_or_executor to invoke the given function object.
get_inner_executor	Obtain the underlying executor.
inline_or_executor [constructor]	Default constructor. — Construct an inline_or_executor for the specified executor. — Copy constructor. — Converting constructor. — Move constructor. — Converting move constructor.
on_work_finished	Inform the inline_or_executor that some work is no longer outstanding.
on_work_started	Inform the inline_or_executor that it has some outstanding work to do.
operator=	Assignment operator. — Converting assignment operator. — Move assignment operator. — Converting move assignment operator.
post	Request the inline_or_executor to invoke the given function object.
prefer	Forward a preference to the underlying executor.
query	Forward a query to the underlying executor.
query [static]	Query the current value of the blocking property. — Query the current value of the inline_exception_handling 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 inline_exception_handling.propagate property. — Obtain an executor with the inline_exception_handling.terminate property. — Forward a requirement to the underlying executor.
~inline_or_executor [destructor]	Destructor.

Friends

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

The inline_or_executor class template adapts an existing executor such that:

posted function objects (or when the blocking property is set to blocking.never) are submitted to the wrapped executor; and
dispatched function objects (or when blocking is blocking.always or blocking.possibly) are executed inline.

Requirements

Header: boost/asio/inline_or_executor.hpp

Convenience header: boost/asio.hpp