SObjectizer  5.5
Public Member Functions | Private Types | List of all members
so_5::mchain_select_params_t< Msg_Count_Status > Class Template Referencefinal

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

#include <mchain_select.hpp>

Inheritance diagram for so_5::mchain_select_params_t< Msg_Count_Status >:
so_5::mchain_bulk_processing_params_t< mchain_props::details::adv_select_data_t, mchain_select_params_t< Msg_Count_Status > > so_5::mchain_props::details::mchain_bulk_processing_basic_params_t< mchain_props::details::adv_select_data_t >

Public Member Functions

template<mchain_props::msg_count_status_t New_Msg_Count_Status>
decltype(auto) SO_5_NODISCARD so5_clone_if_necessary () noexcept
 
 mchain_select_params_t ()=default
 The default constructor. More...
 
 mchain_select_params_t (typename base_type::data_type data)
 Initializing constructor for the case of cloning. More...
 
- 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. More...
 
 mchain_bulk_processing_params_t (mchain_props::details::adv_select_data_t data)
 Initializing constructor. More...
 
decltype(auto) handle_all () noexcept
 
decltype(auto) extract_n (std::size_t v) noexcept
 Set limit for count of messages to be extracted. More...
 
decltype(auto) handle_n (std::size_t v) noexcept
 Set limit for count of messages to be handled. More...
 
actual_typeempty_timeout (Timeout v) noexcept
 Set timeout for waiting on empty chain. More...
 
actual_typeno_wait_on_empty () noexcept
 Disable waiting on the empty queue. More...
 
actual_typetotal_time (Timeout v) noexcept
 Set total time for the whole receive operation. More...
 
actual_typestop_on (typename basic_t::stop_predicate_t predicate) noexcept
 Set user condition for stopping receive operation. More...
 
actual_typeon_close (typename basic_t::chain_closed_handler_t handler) noexcept
 Set handler for chain-closed event. More...
 
- 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. More...
 
 mchain_bulk_processing_basic_params_t (mchain_props::details::adv_select_data_t data)
 Initializing constructor. More...
 
std::size_t to_extract () const noexcept
 Get limit for count of messages to be extracted. More...
 
std::size_t to_handle () const noexcept
 Get limit for count of message to be handled. More...
 
const mchain_props::duration_tempty_timeout () const noexcept
 Get timeout for waiting on empty chain. More...
 
const mchain_props::duration_ttotal_time () const noexcept
 Get total time for the whole receive operation. More...
 
const stop_predicate_tstop_on () const noexcept
 Get user condition for stopping receive operation. More...
 
const chain_closed_handler_tclosed_handler () const noexcept
 Get handler for chain-closed event. More...
 
const auto & so5_data () const noexcept
 Access to internal data. More...
 

Private Types

using base_type = mchain_bulk_processing_params_t< mchain_props::details::adv_select_data_t, mchain_select_params_t< Msg_Count_Status > >
 

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 = mchain_select_params_t< Msg_Count_Status >
 
using data_type = mchain_props::details::adv_select_data_t
 
- 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 = typename mchain_props::details::adv_select_data_t ::stop_predicate_t
 Type of stop-predicate. More...
 
using chain_closed_handler_t = typename mchain_props::details::adv_select_data_t ::chain_closed_handler_t
 Type of chain-closed event. More...
 
- 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_typeself_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. More...
 
void set_handle_n (std::size_t v) noexcept
 Set limit for count of messages to be handled. More...
 
void set_empty_timeout (Timeout v) noexcept
 Set timeout for waiting on empty chain. More...
 
void set_total_time (Timeout v) noexcept
 Set total time for the whole receive operation. More...
 
void set_stop_on (stop_predicate_t predicate) noexcept
 Set user condition for stopping receive operation. More...
 
void set_on_close (chain_closed_handler_t handler) noexcept
 Set handler for chain-closed event. More...
 

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

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 = mchain_bulk_processing_params_t< mchain_props::details::adv_select_data_t, mchain_select_params_t< Msg_Count_Status > >
private

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.

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_NODISCARD so_5::mchain_select_params_t< Msg_Count_Status >::so5_clone_if_necessary ( )
inlinenoexcept

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


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