so_5::mchain_params_t Class Reference

Parameters for message chain. More...

#include <mchain.hpp>

Public Member Functions
	mchain_params_t (mchain_props::capacity_t capacity)
	Initializing constructor.
mchain_params_t &	capacity (mchain_props::capacity_t capacity)
	Set chain's capacity and related params.
const mchain_props::capacity_t &	capacity () const
	Get chain's capacity and related params.
mchain_params_t &	not_empty_notificator (mchain_props::not_empty_notification_func_t notificator)
	Set chain's notificator for 'not_empty' condition.
const mchain_props::not_empty_notification_func_t &	not_empty_notificator () const
	Get chain's notificator for 'not_empty' condition.
mchain_params_t &	empty_notificator (mchain_props::empty_notification_func_t notificator)
	Set chain's notificator for 'empty' condition.
const mchain_props::empty_notification_func_t &	empty_notificator () const
	Get chain's notificator for 'empty' condition.
mchain_params_t &	disable_msg_tracing ()
	Disable message delivery tracing explicitly.
bool	msg_tracing_disabled () const
	Is message delivery tracing disabled explicitly?

Private Attributes
mchain_props::capacity_t	m_capacity
	Chain's capacity.
mchain_props::not_empty_notification_func_t	m_not_empty_notificator
	An optional notificator for 'not_empty' condition.
mchain_props::empty_notification_func_t	m_empty_notificator
	An optional notificator for 'empty' condition.
bool	m_msg_tracing_disabled = { false }
	Is message delivery tracing disabled explicitly?

Detailed Description

Parameters for message chain.

Since

v.5.5.13

Definition at line 740 of file mchain.hpp.

Constructor & Destructor Documentation

mchain_params_t()

so_5::mchain_params_t::mchain_params_t ( mchain_props::capacity_t capacity )

inline

Initializing constructor.

Parameters

capacity

Chain's capacity and related params.

Definition at line 759 of file mchain.hpp.

Member Function Documentation

capacity() [1/2]

const mchain_props::capacity_t & so_5::mchain_params_t::capacity ( ) const

inline

Get chain's capacity and related params.

Definition at line 775 of file mchain.hpp.

capacity() [2/2]

mchain_params_t & so_5::mchain_params_t::capacity ( mchain_props::capacity_t capacity )

inline

Set chain's capacity and related params.

Definition at line 767 of file mchain.hpp.

disable_msg_tracing()

mchain_params_t & so_5::mchain_params_t::disable_msg_tracing ( )

inline

Disable message delivery tracing explicitly.

If this method called then message delivery tracing will not be used for that mchain even if message delivery tracing will be used for the whole SObjectizer Environment.

Definition at line 829 of file mchain.hpp.

empty_notificator() [1/2]

const mchain_props::empty_notification_func_t & so_5::mchain_params_t::empty_notificator ( ) const

inline

Get chain's notificator for 'empty' condition.

Definition at line 817 of file mchain.hpp.

empty_notificator() [2/2]

mchain_params_t & so_5::mchain_params_t::empty_notificator ( mchain_props::empty_notification_func_t notificator )

inline

Set chain's notificator for 'empty' condition.

This notificator will be called when the mchain becomes empty after extraction of the last message.

Since

v.5.8.5

Definition at line 808 of file mchain.hpp.

msg_tracing_disabled()

bool so_5::mchain_params_t::msg_tracing_disabled ( ) const

inline

Is message delivery tracing disabled explicitly?

Definition at line 837 of file mchain.hpp.

not_empty_notificator() [1/2]

const mchain_props::not_empty_notification_func_t & so_5::mchain_params_t::not_empty_notificator ( ) const

inline

Get chain's notificator for 'not_empty' condition.

Definition at line 795 of file mchain.hpp.

not_empty_notificator() [2/2]

mchain_params_t & so_5::mchain_params_t::not_empty_notificator ( mchain_props::not_empty_notification_func_t notificator )

inline

Set chain's notificator for 'not_empty' condition.

This notificator will be called when a message is stored to the empty chain and chain becomes not empty.

Definition at line 786 of file mchain.hpp.

Member Data Documentation

m_capacity

mchain_props::capacity_t so_5::mchain_params_t::m_capacity

private

Chain's capacity.

Definition at line 743 of file mchain.hpp.

m_empty_notificator

mchain_props::empty_notification_func_t so_5::mchain_params_t::m_empty_notificator

private

An optional notificator for 'empty' condition.

Since

v.5.8.5

Definition at line 752 of file mchain.hpp.

m_msg_tracing_disabled

bool so_5::mchain_params_t::m_msg_tracing_disabled = { false }

private

Is message delivery tracing disabled explicitly?

Definition at line 755 of file mchain.hpp.

m_not_empty_notificator

mchain_props::not_empty_notification_func_t so_5::mchain_params_t::m_not_empty_notificator

private

An optional notificator for 'not_empty' condition.

Definition at line 746 of file mchain.hpp.

---

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

• mchain.hpp