Parameters for advanced receive from mchain. More...
#include <mchain.hpp>
Inheritance diagram for so_5::mchain_receive_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_receive_params_t (mchain_t chain) | |
| Initializing constructor. More... | |
| mchain_receive_params_t (typename base_type::data_type data) | |
| Initializing constructor for the case of cloning. More... | |
| const mchain_t & | chain () const |
| Chain from which messages must be extracted and handled. More... | |
 Public Member Functions inherited from so_5::mchain_bulk_processing_params_t< mchain_props::details::adv_receive_data_t, mchain_receive_params_t< Msg_Count_Status > > | |
| mchain_bulk_processing_params_t ()=default | |
| Default constructor. More... | |
| mchain_bulk_processing_params_t (mchain_props::details::adv_receive_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_type & | empty_timeout (Timeout v) noexcept |
| Set timeout for waiting on empty chain. More... | |
| actual_type & | no_wait_on_empty () noexcept |
| Disable waiting on the empty queue. More... | |
| actual_type & | total_time (Timeout v) noexcept |
| Set total time for the whole receive operation. More... | |
| actual_type & | stop_on (typename basic_t::stop_predicate_t predicate) noexcept |
| Set user condition for stopping receive operation. More... | |
| actual_type & | on_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_receive_data_t > | |
| mchain_bulk_processing_basic_params_t ()=default | |
| Default constructor. More... | |
| mchain_bulk_processing_basic_params_t (mchain_props::details::adv_receive_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_t & | empty_timeout () const noexcept |
| Get timeout for waiting on empty chain. More... | |
| const mchain_props::duration_t & | total_time () const noexcept |
| Get total time for the whole receive operation. More... | |
| const stop_predicate_t & | stop_on () const noexcept |
| Get user condition for stopping receive operation. More... | |
| const chain_closed_handler_t & | closed_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_receive_data_t, mchain_receive_params_t< Msg_Count_Status > > |
| Short alias for base type. More... | |
Detailed Description
template<mchain_props::msg_count_status_t Msg_Count_Status>
class so_5::mchain_receive_params_t< Msg_Count_Status >
Parameters for advanced receive from mchain.
- See also
- so_5::from().
- Note
- Derived from basic_receive_params_t since v.5.5.16.
- Template Parameters
-
Msg_Count_Status status of message count limit.
- Since
- v.5.5.13
Member Typedef Documentation
◆ base_type
template<mchain_props::msg_count_status_t Msg_Count_Status>
|
private |
Short alias for base type.
Constructor & Destructor Documentation
◆ mchain_receive_params_t() [1/2]
template<mchain_props::msg_count_status_t Msg_Count_Status>
|
inline |
Initializing constructor.
- Parameters
-
chain Chain from which messages must be extracted and handled.
◆ mchain_receive_params_t() [2/2]
template<mchain_props::msg_count_status_t Msg_Count_Status>
|
inline |
Initializing constructor for the case of cloning.
Member Function Documentation
◆ chain()
template<mchain_props::msg_count_status_t Msg_Count_Status>
|
inline |
Chain from which messages must be extracted and handled.
◆ 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>
|
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:
