so_5::mchain_select_params_t< Msg_Count_Status > Class Template Reference

Parameters for advanced select from multiple mchains. More...

#include <mchain_select.hpp>

Inheritance diagram for so_5::mchain_select_params_t< Msg_Count_Status >:

Public Member Functions
template<mchain_props::msg_count_status_t New_Msg_Count_Status>
decltype(auto)	so5_clone_if_necessary () noexcept
	mchain_select_params_t ()=default
	The default constructor.
	mchain_select_params_t (typename base_type::data_type data)
	Initializing constructor for the case of cloning.
Public Member Functions inherited from so_5::mchain_bulk_processing_params_t< mchain_props::details::adv_select_data_t, mchain_select_params_t< Msg_Count_Status > >
	mchain_bulk_processing_params_t ()=default
	Default constructor.
	mchain_bulk_processing_params_t (mchain_props::details::adv_select_data_t data)
	Initializing constructor.
decltype(auto)	handle_all () noexcept
decltype(auto)	extract_n (std::size_t v) noexcept
	Set limit for count of messages to be extracted.
decltype(auto)	handle_n (std::size_t v) noexcept
	Set limit for count of messages to be handled.
actual_type &	empty_timeout (Timeout v) noexcept
	Set timeout for waiting on empty chain.
actual_type &	no_wait_on_empty () noexcept
	Disable waiting on the empty queue.
actual_type &	total_time (Timeout v) noexcept
	Set total time for the whole receive operation.
actual_type &	stop_on (typename basic_t::stop_predicate_t predicate) noexcept
	Set user condition for stopping receive operation.
actual_type &	on_close (typename basic_t::chain_closed_handler_t handler) noexcept
	Set handler for chain-closed event.
Public Member Functions inherited from so_5::mchain_props::details::mchain_bulk_processing_basic_params_t< mchain_props::details::adv_select_data_t >
	mchain_bulk_processing_basic_params_t ()=default
	Default constructor.
	mchain_bulk_processing_basic_params_t (mchain_props::details::adv_select_data_t data)
	Initializing constructor.
std::size_t	to_extract () const noexcept
	Get limit for count of messages to be extracted.
std::size_t	to_handle () const noexcept
	Get limit for count of message to be handled.
const mchain_props::duration_t &	empty_timeout () const noexcept
	Get timeout for waiting on empty chain.
const mchain_props::duration_t &	total_time () const noexcept
	Get total time for the whole receive operation.
const stop_predicate_t &	stop_on () const noexcept
	Get user condition for stopping receive operation.
const chain_closed_handler_t &	closed_handler () const noexcept
	Get handler for chain-closed event.
const auto &	so5_data () const noexcept
	Access to internal data.

Private Types
using	base_type

Additional Inherited Members
Public Types inherited from so_5::mchain_bulk_processing_params_t< mchain_props::details::adv_select_data_t, mchain_select_params_t< Msg_Count_Status > >
using	actual_type
using	data_type
Public Types inherited from so_5::mchain_props::details::mchain_bulk_processing_basic_params_t< mchain_props::details::adv_select_data_t >
using	stop_predicate_t
	Type of stop-predicate.
using	chain_closed_handler_t
	Type of chain-closed event.
Protected Member Functions inherited from so_5::mchain_bulk_processing_params_t< mchain_props::details::adv_select_data_t, mchain_select_params_t< Msg_Count_Status > >
actual_type &	self_reference ()
decltype(auto)	clone_as_defined () noexcept
Protected Member Functions inherited from so_5::mchain_props::details::mchain_bulk_processing_basic_params_t< mchain_props::details::adv_select_data_t >
void	set_extract_n (std::size_t v) noexcept
	Set limit for count of messages to be extracted.
void	set_handle_n (std::size_t v) noexcept
	Set limit for count of messages to be handled.
void	set_empty_timeout (Timeout v) noexcept
	Set timeout for waiting on empty chain.
void	set_total_time (Timeout v) noexcept
	Set total time for the whole receive operation.
void	set_stop_on (stop_predicate_t predicate) noexcept
	Set user condition for stopping receive operation.
void	set_on_close (chain_closed_handler_t handler) noexcept
	Set handler for chain-closed event.

Detailed Description

template<mchain_props::msg_count_status_t Msg_Count_Status>
class so_5::mchain_select_params_t< Msg_Count_Status >

Parameters for advanced select from multiple mchains.

See also

so_5::select().

Note

Adds nothing to mchain_bulk_processing_params_t.

Since

v.5.5.16

Definition at line 161 of file mchain_select.hpp.

Member Typedef Documentation

base_type

template<mchain_props::msg_count_status_t Msg_Count_Status>

using so_5::mchain_select_params_t< Msg_Count_Status >::base_type

private

Initial value:

 mchain_bulk_processing_params_t<
        mchain_props::details::adv_select_data_t,
        mchain_select_params_t< Msg_Count_Status > >

Definition at line 166 of file mchain_select.hpp.

Constructor & Destructor Documentation

mchain_select_params_t() [1/2]

template<mchain_props::msg_count_status_t Msg_Count_Status>

so_5::mchain_select_params_t< Msg_Count_Status >::mchain_select_params_t ( )

default

The default constructor.

mchain_select_params_t() [2/2]

template<mchain_props::msg_count_status_t Msg_Count_Status>

so_5::mchain_select_params_t< Msg_Count_Status >::mchain_select_params_t ( typename base_type::data_type data )

inline

Initializing constructor for the case of cloning.

Definition at line 190 of file mchain_select.hpp.

Member Function Documentation

so5_clone_if_necessary()

template<mchain_props::msg_count_status_t Msg_Count_Status>

template<mchain_props::msg_count_status_t New_Msg_Count_Status>

decltype(auto) so_5::mchain_select_params_t< Msg_Count_Status >::so5_clone_if_necessary ( )

inlinenodiscardnoexcept

Make of clone with different Msg_Count_Status or return a reference to the same object.

Definition at line 176 of file mchain_select.hpp.

---

The documentation for this class was generated from the following file:

• mchain_select.hpp