so_5::message_t Class Reference

A base class for agent messages. More...

#include <message.hpp>

Inheritance diagram for so_5::message_t:

Public Types
using	kind_t = ::so_5::message_kind_t
	A short typedef for kind of message.

Public Member Functions
	message_t ()
	message_t (const message_t &other)
	message_t (message_t &&other)
message_t &	operator= (const message_t &other)
message_t &	operator= (message_t &&other) noexcept
virtual	~message_t () noexcept=default
Public 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.

Private Member Functions
virtual message_mutability_t	so5_message_mutability () const noexcept
	Get message mutability flag.
virtual void	so5_change_mutability (message_mutability_t mutability)
	Change message mutabilty flag.
virtual kind_t	so5_message_kind () const noexcept
	Detect the kind of the message.

Private Attributes
message_mutability_t	m_mutability
	Is message mutable or immutable?

Friends
class	impl::internal_message_iface_t
message_mutability_t	message_mutability (const intrusive_ptr_t< message_t > &what) noexcept
	Helper method for safe get of message mutability flag.
message_mutability_t	message_mutability (const message_t &what) noexcept
	Helper method for get message mutability flag.
void	change_message_mutability (intrusive_ptr_t< message_t > &what, message_mutability_t mutability)
	Helper method for safe change message mutability flag.
void	change_message_mutability (message_t &what, message_mutability_t mutability)
	Helper method for change message mutability flag.
message_kind_t	message_kind (const so_5::intrusive_ptr_t< message_t > &what)
	Helper method for quering kind of the message.
message_kind_t	message_kind (const message_t &what)
	Helper method for quering kind of the message.

Detailed Description

A base class for agent messages.

All messages for agents must be derived from this class.

Attention

This class should be used for all messages which have an actual message data. For signals (messages without any data) a signal_t class should be used as a base class.

Note

Class message_t is derived from atomic_refcounted_t. But atomic_refcounted_t is not Copyable or Movable class. It means that copy/move constructors and operators for message_t have no influence on the reference counter inside message_t.

Examples

so_5/agent_name/main.cpp, so_5/chameneos_prealloc_msgs/main.cpp, so_5/custom_direct_mbox/main.cpp, so_5/custom_work_thread_factory/main.cpp, so_5/introduce_named_mbox/main.cpp, so_5/modify_resend_as_immutable/main.cpp, so_5/mutable_msg_agents/main.cpp, so_5/news_board/main.cpp, so_5/prio_work_stealing/main.cpp, so_5/simple_message_deadline/main.cpp, so_5/single_sink_binding/main.cpp, and so_5/unique_subscribers_mbox/main.cpp.

Definition at line 46 of file message.hpp.

Member Typedef Documentation

kind_t

using so_5::message_t::kind_t = ::so_5::message_kind_t

A short typedef for kind of message.

Since

v.5.5.23

Definition at line 54 of file message.hpp.

Constructor & Destructor Documentation

message_t() [1/3]

so_5::message_t::message_t

(

)

Definition at line 14 of file message.cpp.

message_t() [2/3]

so_5::message_t::message_t

(

const message_t &

other

)

Definition at line 19 of file message.cpp.

message_t() [3/3]

so_5::message_t::message_t

(

message_t &&

other

)

Definition at line 25 of file message.cpp.

~message_t()

virtual so_5::message_t::~message_t ( )

virtualdefaultnoexcept

Member Function Documentation

operator=() [1/2]

message_t & so_5::message_t::operator=

(

const message_t &

other

)

Definition at line 32 of file message.cpp.

operator=() [2/2]

message_t & so_5::message_t::operator= ( message_t && other )

noexcept

Definition at line 39 of file message.cpp.

so5_change_mutability()

virtual void so_5::message_t::so5_change_mutability ( message_mutability_t mutability )

inlineprivatevirtual

Change message mutabilty flag.

Attention

Changing mutability from message_mutability_t::immutable_message to message_mutability_t::mutable_message is a very bad idea. Please don't do this until you are know what you are doing.

Note

This method is intended to be used by SObjectizer and low-level SObjectizer extension. Because of that it is not guaranteed that this method is part of stable SObjectizer API. It can be changed or even removed in any future versions of SObjectizer.

Attention

This function can throw. For example a derived class can prohibit changing of message mutability.

Since

v.5.5.19

Parameters

mutability

New mutability flag for

Definition at line 228 of file message.hpp.

so5_message_kind()

virtual kind_t so_5::message_t::so5_message_kind ( ) const

inlineprivatevirtualnoexcept

Detect the kind of the message.

Note

This method is intended to be used by SObjectizer and low-level SObjectizer extension. Because of that it is not guaranteed that this method is part of stable SObjectizer API. It can be changed or even removed in any future versions of SObjectizer.

Since

v.5.5.23

Reimplemented in so_5::enveloped_msg::envelope_t, so_5::signal_t, and so_5::user_type_message_t< T >.

Definition at line 248 of file message.hpp.

so5_message_mutability()

virtual message_mutability_t so_5::message_t::so5_message_mutability ( ) const

inlineprivatevirtualnoexcept

Get message mutability flag.

Note

This method is intended to be used by SObjectizer and low-level SObjectizer extension. Because of that it is not guaranteed that this method is part of stable SObjectizer API. It can be changed or even removed in any future versions of SObjectizer.

Since

v.5.5.19

Definition at line 203 of file message.hpp.

Friends And Related Symbol Documentation

change_message_mutability [1/2]

void change_message_mutability ( intrusive_ptr_t< message_t > & what, message_mutability_t mutability )

friend

Helper method for safe change message mutability flag.

Use this method instead of direct call to so5_change_mutability() because what will be nullptr for signals.

Note

This is a very dangerous operation. Don't do it by yourselt. See message_t::so5_change_mutability() for more details.

Attention

This function can throw. For example underlying message object can prohibit changing of message mutability.

Parameters

what	Message instance to be modified if it is not a signal.
mutability	New mutability flag for the message.

Definition at line 107 of file message.hpp.

change_message_mutability [2/2]

void change_message_mutability ( message_t & what, message_mutability_t mutability )

friend

Helper method for change message mutability flag.

Note

This is a very dangerous operation. Don't do it by yourselt. See message_t::so5_change_mutability() for more details.

Attention

This function can throw. For example underlying message object can prohibit changing of message mutability.

Parameters

what	Message instance to be modified.
mutability	New mutability flag for the message.

Definition at line 130 of file message.hpp.

impl::internal_message_iface_t

friend class impl::internal_message_iface_t

friend

Definition at line 48 of file message.hpp.

message_kind [1/2]

message_kind_t message_kind ( const message_t & what )

friend

Helper method for quering kind of the message.

Note

This function is part of internal implementation of SObjectizer. Don't use it directly. It can be a subject of changes in some future versions.

Since

v.5.5.23

Definition at line 174 of file message.hpp.

message_kind [2/2]

message_kind_t message_kind ( const so_5::intrusive_ptr_t< message_t > & what )

friend

Helper method for quering kind of the message.

This helper function is necessary because it correctly handles case when message is a signal. In that case pointer to message instance will be null.

Note

This function is part of internal implementation of SObjectizer. Don't use it directly. It can be a subject of changes in some future versions.

Since

v.5.5.23

Definition at line 154 of file message.hpp.

message_mutability [1/2]

message_mutability_t message_mutability ( const intrusive_ptr_t< message_t > & what )

friend

Helper method for safe get of message mutability flag.

Use this method instead of direct call to so5_message_mutability() because what will be nullptr for signals.

Definition at line 74 of file message.hpp.

message_mutability [2/2]

message_mutability_t message_mutability ( const message_t & what )

friend

Helper method for get message mutability flag.

Definition at line 86 of file message.hpp.

Member Data Documentation

m_mutability

message_mutability_t so_5::message_t::m_mutability

private

Is message mutable or immutable?

By default the message is immutable.

Since

v.5.5.19

Definition at line 188 of file message.hpp.

---

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

• message.hpp
• message.cpp