Mail box class. More...

#include <mbox.hpp>

Inheritance diagram for so_5::abstract_message_box_t:

Public Member Functions
	abstract_message_box_t ()=default

virtual	~abstract_message_box_t () noexcept=default

virtual mbox_id_t	id () const =0
	Unique ID of this mbox.

virtual void	subscribe_event_handler (const std::type_index &type_index, abstract_message_sink_t &subscriber)=0
	Add the message handler.

virtual void	unsubscribe_event_handler (const std::type_index &type_index, abstract_message_sink_t &subscriber) noexcept=0
	Remove all message handlers.

virtual std::string	query_name () const =0
	Get the mbox name.

virtual mbox_type_t	type () const =0
	Get the type of message box.

virtual void	do_deliver_message (message_delivery_mode_t delivery_mode, const std::type_index &msg_type, const message_ref_t &message, unsigned int redirection_deep)=0
	Deliver message for all subscribers with respect to message limits.

virtual so_5::environment_t &	environment () const noexcept=0
	SObjectizer Environment for which the mbox is created.

Methods for working with delivery filters.
virtual void	set_delivery_filter (const std::type_index &msg_type, const delivery_filter_t &filter, abstract_message_sink_t &subscriber)=0
	Set a delivery filter for message type and subscriber.

virtual void	drop_delivery_filter (const std::type_index &msg_type, abstract_message_sink_t &subscriber) noexcept=0
	Removes delivery filter for message type and subscriber.

Private Member Functions
	abstract_message_box_t (const abstract_message_box_t &)=delete

	abstract_message_box_t (abstract_message_box_t &&)=delete

abstract_message_box_t &	operator= (const abstract_message_box_t &)=delete

abstract_message_box_t &	operator= (abstract_message_box_t &&)=delete

Friends
class	intrusive_ptr_t< abstract_message_box_t >

class	so_5::impl::mbox_iface_for_timers_t

Additional Inherited Members
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 () noexcept
	Default constructor.

	~atomic_refcounted_t () noexcept=default
	Destructor.

void	inc_ref_count () noexcept
	Increments reference count.

unsigned long	dec_ref_count () noexcept
	Decrement reference count.

Detailed Description

Mail box class.

The class serves as an interface for sending and receiving messages.

All mboxes can be created via the SObjectizer Environment. References to mboxes are stored and manipulated by so_5::mbox_t objects.

See also: environment_t::schedule_timer(), environment_t::single_timer().

Examples: so_5/custom_direct_mbox/main.cpp.

Definition at line 185 of file mbox.hpp.

Constructor & Destructor Documentation

◆ abstract_message_box_t() [1/3]

so_5::abstract_message_box_t::abstract_message_box_t ( const abstract_message_box_t & )

privatedelete

◆ abstract_message_box_t() [2/3]

so_5::abstract_message_box_t::abstract_message_box_t ( abstract_message_box_t && )

privatedelete

◆ abstract_message_box_t() [3/3]

so_5::abstract_message_box_t::abstract_message_box_t ( )

default

◆ ~abstract_message_box_t()

virtual so_5::abstract_message_box_t::~abstract_message_box_t ( )

virtualdefaultnoexcept

Member Function Documentation

◆ do_deliver_message()

virtual void so_5::abstract_message_box_t::do_deliver_message	(	message_delivery_mode_t	delivery_mode,
		const std::type_index &	msg_type,
		const message_ref_t &	message,
		unsigned int	redirection_deep )

pure virtual

Deliver message for all subscribers with respect to message limits.

Since: v.5.5.4

A message delivery from timer thread is somewhat different from an ordinary message delivery. Especially in the case when target mbox is a message chain. If that message chain is full and some kind of overflow reaction is specified (like waiting for some time or throwing an exception) then it can lead to undesired behaviour of the whole application. To take care about these cases a new method is introduced.

Note: Since v.5.6.0 this method is used for deliverance of ordinary messages/signals and for deliverance of enveloped messages.

Parameters

delivery_mode	Can the delivery blocks the current thread?
msg_type	Type of the message to deliver.
message	A message instance to be delivered.
redirection_deep	Current deep of overlimit reaction recursion.

Implemented in so_5::impl::local_mbox_template< Tracing_Base >, so_5::impl::mpsc_mbox_template_t< Tracing_Base, Limits_Handling_Mixin >, so_5::impl::named_local_mbox_t, so_5::mchain_props::mchain_template< Queue, Tracing_Base >, so_5::msg_tracing::impl::special_enveloping_mbox_t, so_5::stats::impl::st_env_stuff::next_turn_mbox_t, and so_5::unique_subscribers_mbox_impl::actual_mbox_t< Mutex, Tracing_Base >.

Examples: so_5/custom_direct_mbox/main.cpp.

◆ drop_delivery_filter()

virtual void so_5::abstract_message_box_t::drop_delivery_filter	(	const std::type_index &	msg_type,
		abstract_message_sink_t &	subscriber )

pure virtualnoexcept

Removes delivery filter for message type and subscriber.

Since: v.5.5.5

Implemented in so_5::impl::local_mbox_template< Tracing_Base >, so_5::impl::mpsc_mbox_template_t< Tracing_Base, Limits_Handling_Mixin >, so_5::impl::named_local_mbox_t, so_5::mchain_props::mchain_template< Queue, Tracing_Base >, so_5::msg_tracing::impl::special_enveloping_mbox_t, so_5::stats::impl::st_env_stuff::next_turn_mbox_t, and so_5::unique_subscribers_mbox_impl::actual_mbox_t< Mutex, Tracing_Base >.

Examples: so_5/custom_direct_mbox/main.cpp.

◆ environment()

virtual so_5::environment_t & so_5::abstract_message_box_t::environment ( ) const

nodiscardpure virtualnoexcept

SObjectizer Environment for which the mbox is created.

Since: v.5.6.0

Implemented in so_5::abstract_message_chain_t, so_5::impl::local_mbox_template< Tracing_Base >, so_5::impl::mpsc_mbox_template_t< Tracing_Base, Limits_Handling_Mixin >, so_5::impl::named_local_mbox_t, so_5::mchain_props::mchain_template< Queue, Tracing_Base >, so_5::msg_tracing::impl::special_enveloping_mbox_t, so_5::stats::impl::st_env_stuff::next_turn_mbox_t, and so_5::unique_subscribers_mbox_impl::actual_mbox_t< Mutex, Tracing_Base >.

Examples: so_5/custom_direct_mbox/main.cpp.

◆ id()

virtual mbox_id_t so_5::abstract_message_box_t::id ( ) const

nodiscardpure virtual

Unique ID of this mbox.

Since: v.5.4.0

Implemented in so_5::abstract_message_chain_t, so_5::impl::local_mbox_template< Tracing_Base >, so_5::impl::mpsc_mbox_template_t< Tracing_Base, Limits_Handling_Mixin >, so_5::impl::named_local_mbox_t, so_5::mchain_props::mchain_template< Queue, Tracing_Base >, so_5::msg_tracing::impl::special_enveloping_mbox_t, so_5::stats::impl::st_env_stuff::next_turn_mbox_t, and so_5::unique_subscribers_mbox_impl::actual_mbox_t< Mutex, Tracing_Base >.

Examples: so_5/custom_direct_mbox/main.cpp.

◆ operator=() [1/2]

abstract_message_box_t & so_5::abstract_message_box_t::operator= ( abstract_message_box_t && )

privatedelete

◆ operator=() [2/2]

abstract_message_box_t & so_5::abstract_message_box_t::operator= ( const abstract_message_box_t & )

privatedelete

◆ query_name()

virtual std::string so_5::abstract_message_box_t::query_name ( ) const

nodiscardpure virtual

Get the mbox name.

Implemented in so_5::impl::local_mbox_template< Tracing_Base >, so_5::impl::mpsc_mbox_template_t< Tracing_Base, Limits_Handling_Mixin >, so_5::impl::named_local_mbox_t, so_5::mchain_props::mchain_template< Queue, Tracing_Base >, so_5::msg_tracing::impl::special_enveloping_mbox_t, so_5::stats::impl::st_env_stuff::next_turn_mbox_t, and so_5::unique_subscribers_mbox_impl::actual_mbox_t< Mutex, Tracing_Base >.

Examples: so_5/custom_direct_mbox/main.cpp.

◆ set_delivery_filter()

virtual void so_5::abstract_message_box_t::set_delivery_filter	(	const std::type_index &	msg_type,
		const delivery_filter_t &	filter,
		abstract_message_sink_t &	subscriber )

pure virtual

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.

Parameters

msg_type	Message type to be filtered.
filter	Filter to be set. A caller must guaranted the validity of this reference.
subscriber	A subscriber for the message.

Implemented in so_5::impl::local_mbox_template< Tracing_Base >, so_5::impl::mpsc_mbox_template_t< Tracing_Base, Limits_Handling_Mixin >, so_5::impl::named_local_mbox_t, so_5::mchain_props::mchain_template< Queue, Tracing_Base >, so_5::msg_tracing::impl::special_enveloping_mbox_t, so_5::stats::impl::st_env_stuff::next_turn_mbox_t, and so_5::unique_subscribers_mbox_impl::actual_mbox_t< Mutex, Tracing_Base >.

Examples: so_5/custom_direct_mbox/main.cpp.

◆ subscribe_event_handler()

virtual void so_5::abstract_message_box_t::subscribe_event_handler	(	const std::type_index &	type_index,
		abstract_message_sink_t &	subscriber )

pure virtual

Add the message handler.

Parameters

type_index	Message type.
subscriber	Subscriber.

Implemented in so_5::impl::local_mbox_template< Tracing_Base >, so_5::impl::mpsc_mbox_template_t< Tracing_Base, Limits_Handling_Mixin >, so_5::impl::named_local_mbox_t, so_5::mchain_props::mchain_template< Queue, Tracing_Base >, so_5::msg_tracing::impl::special_enveloping_mbox_t, so_5::stats::impl::st_env_stuff::next_turn_mbox_t, and so_5::unique_subscribers_mbox_impl::actual_mbox_t< Mutex, Tracing_Base >.

Examples: so_5/custom_direct_mbox/main.cpp.

◆ type()

virtual mbox_type_t so_5::abstract_message_box_t::type ( ) const

nodiscardpure virtual

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.

Implemented in so_5::impl::local_mbox_template< Tracing_Base >, so_5::impl::mpsc_mbox_template_t< Tracing_Base, Limits_Handling_Mixin >, so_5::impl::named_local_mbox_t, so_5::mchain_props::mchain_template< Queue, Tracing_Base >, so_5::msg_tracing::impl::special_enveloping_mbox_t, so_5::stats::impl::st_env_stuff::next_turn_mbox_t, and so_5::unique_subscribers_mbox_impl::actual_mbox_t< Mutex, Tracing_Base >.

Examples: so_5/custom_direct_mbox/main.cpp.

◆ unsubscribe_event_handler()

virtual void so_5::abstract_message_box_t::unsubscribe_event_handler	(	const std::type_index &	type_index,
		abstract_message_sink_t &	subscriber )

pure virtualnoexcept

Remove all message handlers.

Parameters

type_index	Message type.
subscriber	Subscriber.

Implemented in so_5::impl::local_mbox_template< Tracing_Base >, so_5::impl::mpsc_mbox_template_t< Tracing_Base, Limits_Handling_Mixin >, so_5::impl::named_local_mbox_t, so_5::mchain_props::mchain_template< Queue, Tracing_Base >, so_5::msg_tracing::impl::special_enveloping_mbox_t, so_5::stats::impl::st_env_stuff::next_turn_mbox_t, and so_5::unique_subscribers_mbox_impl::actual_mbox_t< Mutex, Tracing_Base >.

Examples: so_5/custom_direct_mbox/main.cpp.

Friends And Related Symbol Documentation

◆ intrusive_ptr_t< abstract_message_box_t >

friend class intrusive_ptr_t< abstract_message_box_t >

friend

Definition at line 135 of file mbox.hpp.

◆ so_5::impl::mbox_iface_for_timers_t

friend class so_5::impl::mbox_iface_for_timers_t

friend

It is necessary for for access to do_deliver_message_from_timer().

Note: Added in v.5.5.18.

Definition at line 195 of file mbox.hpp.

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

mbox.hpp

Public Member Functions

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ abstract_message_box_t() [1/3]

◆ abstract_message_box_t() [2/3]

◆ abstract_message_box_t() [3/3]

◆ ~abstract_message_box_t()

Member Function Documentation

◆ do_deliver_message()

◆ drop_delivery_filter()

◆ environment()

◆ id()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ query_name()

◆ set_delivery_filter()

◆ subscribe_event_handler()

◆ type()

◆ unsubscribe_event_handler()

Friends And Related Symbol Documentation

◆ intrusive_ptr_t< abstract_message_box_t >

◆ so_5::impl::mbox_iface_for_timers_t