Parameters for advanced receive from mchain. More...

#include <mchain.hpp>

Inheritance diagram for so_5::mchain_receive_params_t:

Public Member Functions
	mchain_receive_params_t (mchain_t chain)
	Initializing constructor. 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_receive_params_t >
actual_type &	extract_n (std::size_t v)
	Set limit for count of messages to be extracted. More...

std::size_t	to_extract () const
	Get limit for count of messages to be extracted. More...

actual_type &	handle_n (std::size_t v)
	Set limit for count of messages to be handled. More...

std::size_t	to_handle () const
	Get limit for count of message to be handled. More...

actual_type &	empty_timeout (Timeout v)
	Set timeout for waiting on empty chain. More...

const mchain_props::duration_t &	empty_timeout () const
	Get timeout for waiting on empty chain. More...

actual_type &	no_wait_on_empty ()
	Disable waiting on the empty queue. More...

actual_type &	total_time (Timeout v)
	Set total time for the whole receive operation. More...

const mchain_props::duration_t &	total_time () const
	Get total time for the whole receive operation. More...

actual_type &	stop_on (stop_predicate predicate)
	Set user condition for stopping receive operation. More...

const stop_predicate &	stop_on () const
	Get user condition for stopping receive operation. More...

actual_type &	on_close (chain_closed_handler handler)
	Set handler for chain-closed event. More...

const chain_closed_handler &	closed_handler () const
	Get handler for chain-closed event. More...

Private Attributes
mchain_t	m_chain
	Chain from which messages must be extracted and handled. More...

Additional Inherited Members
Public Types inherited from so_5::mchain_bulk_processing_params_t< mchain_receive_params_t >
using	actual_type = mchain_receive_params_t
	Actual type of params. More...

using	stop_predicate = std::function< bool() >
	Type of stop-predicate. More...

using	chain_closed_handler = std::function< void(const mchain_t &) >
	Type of chain-closed event. More...

Protected Member Functions inherited from so_5::mchain_bulk_processing_params_t< mchain_receive_params_t >
actual_type &	self_reference ()

Detailed Description

Parameters for advanced receive from mchain.

Constructor & Destructor Documentation

so_5::mchain_receive_params_t::mchain_receive_params_t ( mchain_t chain )

inline

Initializing constructor.

Parameters

chain Chain from which messages must be extracted and handled.

const mchain_t& so_5::mchain_receive_params_t::chain ( ) const

inline

Chain from which messages must be extracted and handled.

mchain_t so_5::mchain_receive_params_t::m_chain

private

Chain from which messages must be extracted and handled.

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