A template with implementation of local mbox. More...

#include <local_mbox.hpp>

Inheritance diagram for so_5::impl::local_mbox_template< Tracing_Base >:

Public Member Functions
template<typename... Tracing_Args>
	local_mbox_template (mbox_id_t id, Tracing_Args &&... args)

virtual mbox_id_t	id () const override
	Unique ID of this mbox. More...

virtual void	subscribe_event_handler (const std::type_index &type_wrapper, const so_5::message_limit::control_block_t limit, agent_t subscriber) override
	Add the message handler. More...

virtual void	unsubscribe_event_handlers (const std::type_index &type_wrapper, agent_t *subscriber) override
	Remove all message handlers. More...

virtual std::string	query_name () const override
	Get the mbox name. More...

virtual mbox_type_t	type () const override
	Get the type of message box. More...

virtual void	do_deliver_message (const std::type_index &msg_type, const message_ref_t &message, unsigned int overlimit_reaction_deep) const override
	Deliver message for all subscribers with respect to message limits. More...

virtual void	do_deliver_service_request (const std::type_index &msg_type, const message_ref_t &message, unsigned int overlimit_reaction_deep) const override
	Deliver service request. More...

void	do_deliver_enveloped_msg (const std::type_index &msg_type, const message_ref_t &message, unsigned int overlimit_reaction_deep) override
	Deliver enveloped message. More...

virtual void	set_delivery_filter (const std::type_index &msg_type, const delivery_filter_t &filter, agent_t &subscriber) override
	Set a delivery filter for message type and subscriber. More...

virtual void	drop_delivery_filter (const std::type_index &msg_type, agent_t &subscriber) SO_5_NOEXCEPT override
	Removes delivery filter for message type and subscriber. More...

Public Member Functions inherited from so_5::abstract_message_box_t
	abstract_message_box_t ()=default

virtual	~abstract_message_box_t () SO_5_NOEXCEPT=default

template<class Message >
void	deliver_message (std::type_index subscription_type, const intrusive_ptr_t< Message > &msg_ref) const
	Deliver message. More...

template<class Message >
void	deliver_message (const intrusive_ptr_t< Message > &msg_ref) const
	Deliver message. More...

template<class Message >
void	deliver_message (std::type_index subscription_type, std::unique_ptr< Message > msg_unique_ptr, message_mutability_t mutability) const
	Deliver message. More...

template<class Message >
void	deliver_message (std::unique_ptr< Message > msg_unique_ptr) const
	Deliver message. More...

template<class Message >
void	deliver_message (Message *msg_raw_ptr) const
	Deliver message. More...

template<class Message >
void	deliver_signal () const
	Deliver signal. More...

template<class Result >
service_invoke_proxy_t< Result >	get_one ()
	Create a special proxy for service request invocation. More...

service_invoke_proxy_t< void >	run_one ()
	Create a special proxy for service request invocation where return type is void. More...

void	deliver_message (const std::type_index &msg_type, const message_ref_t &message) const
	Deliver message for all subscribers. More...

void	deliver_service_request (const std::type_index &msg_type, const message_ref_t &message) const
	Deliver service request. More...

bool	operator== (const abstract_message_box_t &o) const SO_5_NOEXCEPT

bool	operator< (const abstract_message_box_t &o) const SO_5_NOEXCEPT

Private Member Functions
template<typename Info_Maker , typename Info_Changer >
void	insert_or_modify_subscriber (const std::type_index &type_wrapper, agent_t *subscriber, Info_Maker maker, Info_Changer changer)

template<typename Info_Changer >
void	modify_and_remove_subscriber_if_needed (const std::type_index &type_wrapper, agent_t *subscriber, Info_Changer changer)

void	do_deliver_message_impl (typename Tracing_Base::deliver_op_tracer const &tracer, const std::type_index &msg_type, const message_ref_t &message, unsigned int overlimit_reaction_deep, invocation_type_t invocation_type) const

void	do_deliver_message_to_subscriber (const local_mbox_details::subscriber_info_t &agent_info, typename Tracing_Base::deliver_op_tracer const &tracer, const std::type_index &msg_type, const message_ref_t &message, unsigned int overlimit_reaction_deep, invocation_type_t invocation_type) const

void	do_deliver_service_request_impl (typename Tracing_Base::deliver_op_tracer const &tracer, const std::type_index &msg_type, const message_ref_t &message, unsigned int overlimit_reaction_deep) const

void	do_deliver_service_request_to_subscriber (typename Tracing_Base::deliver_op_tracer const &tracer, const local_mbox_details::subscriber_info_t &agent_info, const std::type_index &msg_type, const message_ref_t &message, unsigned int overlimit_reaction_deep) const

void	ensure_immutable_message (const std::type_index &msg_type, const message_ref_t &what) const
	Ensures that message is an immutable message. More...

Private Member Functions inherited from so_5::impl::local_mbox_details::data_t
	data_t (mbox_id_t id)

Additional Inherited Members
Protected Member Functions inherited from so_5::abstract_message_box_t
virtual void	do_deliver_message_from_timer (const std::type_index &msg_type, const message_ref_t &message)
	Special method for message delivery from a timer thread. More...

Protected Member Functions inherited from so_5::atomic_refcounted_t
	atomic_refcounted_t (const atomic_refcounted_t &)=delete

atomic_refcounted_t &	operator= (const atomic_refcounted_t &)=delete

	atomic_refcounted_t () SO_5_NOEXCEPT
	Default constructor. More...

	~atomic_refcounted_t () SO_5_NOEXCEPT=default
	Destructor. More...

void	inc_ref_count () SO_5_NOEXCEPT
	Increments reference count. More...

unsigned long	dec_ref_count () SO_5_NOEXCEPT
	Decrement reference count. More...

Static Protected Member Functions inherited from so_5::abstract_message_box_t
static void	delegate_deliver_message_from_timer (abstract_message_box_t &mbox, const std::type_index &msg_type, const message_ref_t &message)
	Helper for calling do_deliver_message_from_timer in derived classes. More...

Private Types inherited from so_5::impl::local_mbox_details::data_t
typedef std::map< std::type_index, subscriber_adaptive_container_t >	messages_table_t
	Map from message type to subscribers. More...

Private Attributes inherited from so_5::impl::local_mbox_details::data_t
const mbox_id_t	m_id
	ID of this mbox. More...

default_rw_spinlock_t	m_lock
	Object lock. More...

messages_table_t	m_subscribers
	Map of subscribers to messages. More...

Detailed Description

template<typename Tracing_Base>
class so_5::impl::local_mbox_template< Tracing_Base >

A template with implementation of local mbox.

Since: v.5.5.9

Template Parameters

Tracing_Base base class with implementation of message delivery tracing methods.

Constructor & Destructor Documentation

◆ local_mbox_template()

template<typename Tracing_Base >

template<typename... Tracing_Args>

so_5::impl::local_mbox_template< Tracing_Base >::local_mbox_template	(	mbox_id_t	id,
		Tracing_Args &&...	args
	)

inline

Parameters

id	ID of this mbox.
args	Optional parameters for Tracing_Base's constructor.

Member Function Documentation

◆ do_deliver_enveloped_msg()

template<typename Tracing_Base >

void so_5::impl::local_mbox_template< Tracing_Base >::do_deliver_enveloped_msg	(	const std::type_index &	msg_type,
		const message_ref_t &	message,
		unsigned int	overlimit_reaction_deep
	)

inlineoverridevirtual

Deliver enveloped message.

Note: To keep source-code compatibility with previous versions this method is not pure virtual. It has an implementation that throws an exception with rc_not_implemented error code. This method will be marked as pure virtual in v.5.6.0

Since: v.5.5.23

Reimplemented from so_5::abstract_message_box_t.

◆ do_deliver_message()

template<typename Tracing_Base >

virtual void so_5::impl::local_mbox_template< Tracing_Base >::do_deliver_message	(	const std::type_index &	msg_type,
		const message_ref_t &	message,
		unsigned int	overlimit_reaction_deep
	)		const

inlineoverridevirtual

Deliver message for all subscribers with respect to message limits.

Since: v.5.5.4

Note: It is obvious that do_deliver_message() must be non-const method. The constness is here now to keep compatibility in 5.5.* versions. The constness will be removed in v.5.6.0.

Implements so_5::abstract_message_box_t.

◆ do_deliver_message_impl()

template<typename Tracing_Base >

void so_5::impl::local_mbox_template< Tracing_Base >::do_deliver_message_impl	(	typename Tracing_Base::deliver_op_tracer const &	tracer,
		const std::type_index &	msg_type,
		const message_ref_t &	message,
		unsigned int	overlimit_reaction_deep,
		invocation_type_t	invocation_type
	)		const

inlineprivate

◆ do_deliver_message_to_subscriber()

template<typename Tracing_Base >

void so_5::impl::local_mbox_template< Tracing_Base >::do_deliver_message_to_subscriber	(	const local_mbox_details::subscriber_info_t &	agent_info,
		typename Tracing_Base::deliver_op_tracer const &	tracer,
		const std::type_index &	msg_type,
		const message_ref_t &	message,
		unsigned int	overlimit_reaction_deep,
		invocation_type_t	invocation_type
	)		const

inlineprivate

◆ do_deliver_service_request()

template<typename Tracing_Base >

virtual void so_5::impl::local_mbox_template< Tracing_Base >::do_deliver_service_request	(	const std::type_index &	msg_type,
		const message_ref_t &	message,
		unsigned int	overlimit_reaction_deep
	)		const

inlineoverridevirtual

Deliver service request.

Since: v.5.5.4

Note: It is obvious that do_deliver_message() must be non-const method. The constness is here now to keep compatibility in 5.5.* versions. The constness will be removed in v.5.6.0.

Implements so_5::abstract_message_box_t.

◆ do_deliver_service_request_impl()

template<typename Tracing_Base >

void so_5::impl::local_mbox_template< Tracing_Base >::do_deliver_service_request_impl	(	typename Tracing_Base::deliver_op_tracer const &	tracer,
		const std::type_index &	msg_type,
		const message_ref_t &	message,
		unsigned int	overlimit_reaction_deep
	)		const

inlineprivate

◆ do_deliver_service_request_to_subscriber()

template<typename Tracing_Base >

void so_5::impl::local_mbox_template< Tracing_Base >::do_deliver_service_request_to_subscriber	(	typename Tracing_Base::deliver_op_tracer const &	tracer,
		const local_mbox_details::subscriber_info_t &	agent_info,
		const std::type_index &	msg_type,
		const message_ref_t &	message,
		unsigned int	overlimit_reaction_deep
	)		const

inlineprivate

◆ drop_delivery_filter()

template<typename Tracing_Base >

virtual void so_5::impl::local_mbox_template< Tracing_Base >::drop_delivery_filter	(	const std::type_index &	msg_type,
		agent_t &	subscriber
	)

inlineoverridevirtual

Removes delivery filter for message type and subscriber.

Since: v.5.5.5

Implements so_5::abstract_message_box_t.

◆ ensure_immutable_message()

template<typename Tracing_Base >

void so_5::impl::local_mbox_template< Tracing_Base >::ensure_immutable_message	(	const std::type_index &	msg_type,
		const message_ref_t &	what
	)		const

inlineprivate

Ensures that message is an immutable message.

Checks mutability flag and throws an exception if message is a mutable one.

Since: v.5.5.19

◆ id()

template<typename Tracing_Base >

virtual mbox_id_t so_5::impl::local_mbox_template< Tracing_Base >::id ( ) const

inlineoverridevirtual

Unique ID of this mbox.

Since: v.5.4.0

Implements so_5::abstract_message_box_t.

◆ insert_or_modify_subscriber()

template<typename Tracing_Base >

template<typename Info_Maker , typename Info_Changer >

void so_5::impl::local_mbox_template< Tracing_Base >::insert_or_modify_subscriber	(	const std::type_index &	type_wrapper,
		agent_t *	subscriber,
		Info_Maker	maker,
		Info_Changer	changer
	)

inlineprivate

◆ modify_and_remove_subscriber_if_needed()

template<typename Tracing_Base >

template<typename Info_Changer >

void so_5::impl::local_mbox_template< Tracing_Base >::modify_and_remove_subscriber_if_needed	(	const std::type_index &	type_wrapper,
		agent_t *	subscriber,
		Info_Changer	changer
	)

inlineprivate

◆ query_name()

template<typename Tracing_Base >

virtual std::string so_5::impl::local_mbox_template< Tracing_Base >::query_name ( ) const

inlineoverridevirtual

Get the mbox name.

Implements so_5::abstract_message_box_t.

◆ set_delivery_filter()

template<typename Tracing_Base >

virtual void so_5::impl::local_mbox_template< Tracing_Base >::set_delivery_filter	(	const std::type_index &	msg_type,
		const delivery_filter_t &	filter,
		agent_t &	subscriber
	)

inlineoverridevirtual

Set a delivery filter for message type and subscriber.

Since: v.5.5.5

Note: If there already is a delivery filter for that (msg_type,subscriber) pair then old delivery filter will be replaced by new one.

Implements so_5::abstract_message_box_t.

◆ subscribe_event_handler()

template<typename Tracing_Base >

virtual void so_5::impl::local_mbox_template< Tracing_Base >::subscribe_event_handler	(	const std::type_index &	type_index,
		const so_5::message_limit::control_block_t *	limit,
		agent_t *	subscriber
	)

inlineoverridevirtual

Add the message handler.

Implements so_5::abstract_message_box_t.

◆ type()

template<typename Tracing_Base >

virtual mbox_type_t so_5::impl::local_mbox_template< Tracing_Base >::type ( ) const

inlineoverridevirtual

Get the type of message box.

Since: v.5.5.3

Note: This method is primarily intended for internal usage. It is useful sometimes in subscription-related operations because there is no need to do some actions for MPSC mboxes.

Implements so_5::abstract_message_box_t.

◆ unsubscribe_event_handlers()

template<typename Tracing_Base >

virtual void so_5::impl::local_mbox_template< Tracing_Base >::unsubscribe_event_handlers	(	const std::type_index &	type_index,
		agent_t *	subscriber
	)

inlineoverridevirtual

Remove all message handlers.

Implements so_5::abstract_message_box_t.

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

local_mbox.hpp

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

template<typename Tracing_Base> class so_5::impl::local_mbox_template< Tracing_Base >

Constructor & Destructor Documentation

◆ local_mbox_template()

Member Function Documentation

◆ do_deliver_enveloped_msg()

◆ do_deliver_message()

◆ do_deliver_message_impl()

◆ do_deliver_message_to_subscriber()

◆ do_deliver_service_request()

◆ do_deliver_service_request_impl()

◆ do_deliver_service_request_to_subscriber()

◆ drop_delivery_filter()

◆ ensure_immutable_message()

◆ id()

◆ insert_or_modify_subscriber()

◆ modify_and_remove_subscriber_if_needed()

◆ query_name()

◆ set_delivery_filter()

◆ subscribe_event_handler()

◆ type()

◆ unsubscribe_event_handlers()

template<typename Tracing_Base>
class so_5::impl::local_mbox_template< Tracing_Base >