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. More...
mchain_params_t &	capacity (mchain_props::capacity_t capacity)
	Set chain's capacity and related params. More...
const mchain_props::capacity_t &	capacity () const
	Get chain's capacity and related params. More...
mchain_params_t &	not_empty_notificator (mchain_props::not_empty_notification_func_t notificator)
	Set chain's notificator for 'not_empty' condition. More...
const mchain_props::not_empty_notification_func_t &	not_empty_notificator () const
	Get chain's notificator for 'not_empty' condition. More...
mchain_params_t &	disable_msg_tracing ()
	Disable message delivery tracing explicitly. More...
bool	msg_tracing_disabled () const
	Is message delivery tracing disabled explicitly? More...

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

Detailed Description

Parameters for message chain.

Since

v.5.5.13

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.

Member Function Documentation

capacity() [1/2]

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

inline

Set chain's capacity and related params.

capacity() [2/2]

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

inline

Get chain's capacity and related params.

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.

msg_tracing_disabled()

bool so_5::mchain_params_t::msg_tracing_disabled ( ) const

inline

Is message delivery tracing disabled explicitly?

not_empty_notificator() [1/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.

not_empty_notificator() [2/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.

Member Data Documentation

m_capacity

mchain_props::capacity_t so_5::mchain_params_t::m_capacity

private

Chain's capacity.

m_msg_tracing_disabled

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

private

Is message delivery tracing disabled explicitly?

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.

---

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

• mchain.hpp