so_5::disp::mpsc_queue_traits Namespace Reference

Various stuff related to MPSC event queue implementation and tuning. More...

Namespaces
	impl
	Implementation details for MPSC event queue stuff.

Classes
class	lock_guard_t
	An analog of std::lock_guard for MPSC queue lock. More...
class	lock_t
	An interface for lock for MPSC queue. More...
class	queue_params_t
	Container for storing parameters for MPSC queue. More...
class	unique_lock_t
	An analog of std::unique_lock for MPSC queue lock. More...

Typedefs
using	lock_unique_ptr_t = std::unique_ptr< lock_t >
	An alias for unique_ptr for lock. More...
using	lock_factory_t = std::function< lock_unique_ptr_t() >
	Type of lock factory. More...

Functions
SO_5_FUNC lock_factory_t	combined_lock_factory ( std::chrono::high_resolution_clock::duration waiting_time)
	Factory for creation of combined queue lock with the specified waiting time. More...
SO_5_FUNC lock_factory_t	simple_lock_factory ()
	Factory for creation of very simple implementation based on usage of mutex and condition_variable only. More...
std::chrono::high_resolution_clock::duration	default_combined_lock_waiting_time ()
	Default timeout used by combined_lock for waiting on spinlock before switching to mutex-based locking scheme. More...
lock_factory_t	combined_lock_factory ()
	Factory for creation of combined queue lock with default waiting time. More...

Detailed Description

Various stuff related to MPSC event queue implementation and tuning.

Since

v.5.5.10

Typedef Documentation

lock_factory_t

using so_5::disp::mpsc_queue_traits::lock_factory_t = typedef std::function< lock_unique_ptr_t() >

Type of lock factory.

Since

v.5.5.10

lock_unique_ptr_t

using so_5::disp::mpsc_queue_traits::lock_unique_ptr_t = typedef std::unique_ptr< lock_t >

An alias for unique_ptr for lock.

Since

v.5.5.10

Function Documentation

combined_lock_factory() [1/2]

lock_factory_t so_5::disp::mpsc_queue_traits::combined_lock_factory ( )

inline

Factory for creation of combined queue lock with default waiting time.

Since

v.5.5.10

Usage example:

so_5::launch( []( so_5::environment_t & env ) { ... },
  []( so_5::environment_params_t & params ) {
    // Add another one_thread dispatcher with combined_lock for
    // event queue protection.
    using namespace so_5::disp::one_thread;
    params.add_named_dispatcher(
      "helpers_disp",
      create_disp( disp_params_t{}.tune_queue_params(
        []( queue_traits::queue_params_t & queue_params ) {
          queue_params.lock_factory( queue_traits::combined_lock_factory() );
        } ) ) );
  } );

combined_lock_factory() [2/2]

SO_5_FUNC lock_factory_t so_5::disp::mpsc_queue_traits::combined_lock_factory

(

std::chrono::high_resolution_clock::duration

waiting_time

)

Factory for creation of combined queue lock with the specified waiting time.

Since

v.5.5.10

Usage example:

so_5::launch( []( so_5::environment_t & env ) { ... },
  []( so_5::environment_params_t & params ) {
    // Add another one_thread dispatcher with combined_lock for
    // event queue protection.
    using namespace so_5::disp::one_thread;
    params.add_named_dispatcher(
      "helpers_disp",
      create_disp( disp_params_t{}.tune_queue_params(
        []( queue_traits::queue_params_t & queue_params ) {
          // Switching to mutex will be after waiting for 500us.
          queue_params.lock_factory( queue_traits::combined_lock_factory(
            std::chrono::microseconds(500) ) );
        } ) ) );
  } );

Parameters

waiting_time

Max waiting time for waiting on spinlock before switching to mutex.

default_combined_lock_waiting_time()

std::chrono::high_resolution_clock::duration so_5::disp::mpsc_queue_traits::default_combined_lock_waiting_time ( )

inline

Default timeout used by combined_lock for waiting on spinlock before switching to mutex-based locking scheme.

Since

v.5.5.10

simple_lock_factory()

SO_5_FUNC lock_factory_t so_5::disp::mpsc_queue_traits::simple_lock_factory

(

)

Factory for creation of very simple implementation based on usage of mutex and condition_variable only.

Since

v.5.5.10

Usage example:

so_5::launch( []( so_5::environment_t & env ) { ... },
  []( so_5::environment_params_t & params ) {
    // Add another one_thread dispatcher with simple_lock for
    // event queue protection.
    using namespace so_5::disp::one_thread;
    params.add_named_dispatcher(
      "helpers_disp",
      create_disp( disp_params_t{}.tune_queue_params(
        []( queue_traits::queue_params_t & queue_params ) {
          queue_params.lock_factory( queue_traits::simple_lock_factory() );
        } ) ) );
  } );