so_5::disp::thread_pool Namespace Reference

Thread pool dispatcher. More...

Namespaces
	anonymous_namespace{pub.cpp}
	common_implementation
	Reusable implementation of some thread pool dispatcher functionality which can be used in other thread-pool-like dispatchers.
	impl
	Internal implementation details of thread pool dispatcher.

Classes
class	bind_params_t
	Parameters for binding agents to thread_pool dispatcher. More...
class	disp_params_t
	Alias for namespace with traits of event queue. More...
class	dispatcher_handle_t
	A handle for thread_pool dispatcher. More...

Enumerations
enum	fifo_t { fifo_t::cooperation, fifo_t::individual }
	Type of FIFO mechanism for agent's demands. More...

Functions
SO_5_FUNC dispatcher_handle_t	make_dispatcher ( environment_t &env, const std::string_view data_sources_name_base, disp_params_t disp_params)
	Create an instance thread_pool dispatcher. More...
std::size_t	default_thread_pool_size ()
	A helper function for detecting default thread count for thread pool. More...
dispatcher_handle_t	make_dispatcher (environment_t &env, const std::string_view data_sources_name_base, std::size_t thread_count)
	Create an instance of thread_pool dispatcher. More...
dispatcher_handle_t	make_dispatcher (environment_t &env, std::size_t thread_count)
	Create an instance of thread_pool dispatcher. More...
dispatcher_handle_t	make_dispatcher (environment_t &env)
	Create an instance of thread_pool dispatcher with the default count of working threads. More...

Detailed Description

Thread pool dispatcher.

Enumeration Type Documentation

fifo_t

enum so_5::disp::thread_pool::fifo_t

strong

Type of FIFO mechanism for agent's demands.

Since

v.5.4.0

Enumerator
cooperation	A FIFO for demands for all agents from the same cooperation. It means that agents from the same cooperation for which this FIFO mechanism is used will be worked on the same thread.
individual	A FIFO for demands only for one agent. It means that FIFO is only supported for the concrete agent. If several agents from a cooperation have this FIFO type they will process demands independently and on different threads.

Function Documentation

default_thread_pool_size()

std::size_t so_5::disp::thread_pool::default_thread_pool_size ( )

inline

A helper function for detecting default thread count for thread pool.

Returns value of std::thread::hardware_concurrency() or 2 if hardware_concurrency() returns 0.

Since

v.5.4.0

make_dispatcher() [1/4]

SO_5_FUNC dispatcher_handle_t so_5::disp::thread_pool::make_dispatcher	(	environment_t &	env,
		const std::string_view	data_sources_name_base,
		disp_params_t	disp_params
	)

Create an instance thread_pool dispatcher.

Usage sample

using namespace so_5::disp::thread_pool;
auto disp = make_dispatcher(
  env,
  "db_workers_pool",
  disp_params_t{}
    .thread_count( 16 )
    .tune_queue_params( []( queue_traits::queue_params_t & params ) {
        params.lock_factory( queue_traits::simple_lock_factory() );
      } ) );
auto coop = env.make_coop(
  // The main dispatcher for that coop will be
  // this instance of thread_pool dispatcher.
  disp.binder() );

Since

v.5.6.0

Parameters

env	SObjectizer Environment to work in.
data_sources_name_base	Value for creating names of data sources for run-time monitoring.
disp_params	Parameters for the dispatcher.

Examples:

so_5/hardwork_imit/main.cpp, so_5/queue_size_stats/main.cpp, so_5/redirect_and_transform/main.cpp, and so_5/simple_message_deadline/main.cpp.

make_dispatcher() [2/4]

dispatcher_handle_t so_5::disp::thread_pool::make_dispatcher ( environment_t &  env, const std::string_view  data_sources_name_base, std::size_t  thread_count  )

inline

Create an instance of thread_pool dispatcher.

Usage sample

auto disp = so_5::disp::thread_pool::make_dispatcher(
  env,
  "db_workers_pool",
  16 );
auto coop = env.make_coop(
  // The main dispatcher for that coop will be
  // this instance of thread_pool dispatcher.
  disp.binder() );

Since

v.5.6.0

Parameters

env	SObjectizer Environment to work in.
data_sources_name_base	Value for creating names of data sources for run-time monitoring.
thread_count	Count of working threads.

make_dispatcher() [3/4]

dispatcher_handle_t so_5::disp::thread_pool::make_dispatcher ( environment_t &  env, std::size_t  thread_count  )

inline

Create an instance of thread_pool dispatcher.

Usage sample

auto disp = so_5::disp::thread_pool::make_dispatcher( env, 16 );

auto coop = env.make_coop(
  // The main dispatcher for that coop will be
  // this instance of thread_pool dispatcher.
  disp.binder() );

Since

v.5.6.0

Parameters

env	SObjectizer Environment to work in.
thread_count	Count of working threads.

make_dispatcher() [4/4]

dispatcher_handle_t so_5::disp::thread_pool::make_dispatcher ( environment_t &  env )

inline

Create an instance of thread_pool dispatcher with the default count of working threads.

Count of work threads will be detected by default_thread_pool_size() function.

Usage sample

auto disp = so_5::disp::thread_pool::make_instance( env );

auto coop = env.make_coop(
  // The main dispatcher for that coop will be
  // this instance of thread_pool dispatcher.
  disp.binder() );

Since

v.5.6.0

Parameters

env	SObjectizer Environment to work in.