so_5::signal_t Class Reference

A base class for agent signals. More...

#include <message.hpp>

Inheritance diagram for so_5::signal_t:

Public Member Functions
	~signal_t () noexcept override=default
Public Member Functions inherited from so_5::message_t
	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)
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. More...
	~atomic_refcounted_t () noexcept=default
	Destructor. More...
void	inc_ref_count () noexcept
	Increments reference count. More...
unsigned long	dec_ref_count () noexcept
	Decrement reference count. More...

Private Member Functions
	signal_t (const signal_t &)=delete
	signal_t (signal_t &&)=delete
signal_t &	operator= (const signal_t &)=delete
signal_t &	operator= (signal_t &&)=delete
	signal_t ()=default
kind_t	so5_message_kind () const noexcept override
	Detect the kind of the message. More...

Additional Inherited Members
Public Types inherited from so_5::message_t
using	kind_t = ::so_5::message_kind_t
	A short typedef for kind of message. More...

Detailed Description

A base class for agent signals.

Since

v.5.2.0

All signals (messages without any data) for agents should be derived from this class.

Examples:

so_5/adv_thread_pool_fifo/main.cpp, so_5/blinking_led/main.cpp, so_5/chameneos_prealloc_msgs/main.cpp, so_5/chameneos_simple/main.cpp, so_5/chstate/main.cpp, so_5/chstate_msg_tracing/main.cpp, so_5/coop_user_resources/main.cpp, so_5/custom_direct_mbox/main.cpp, so_5/custom_error_logger/main.cpp, so_5/custom_work_thread_factory/main.cpp, so_5/deadletter_handler/main.cpp, so_5/default_message_limits/main.cpp, so_5/delivery_filters/main.cpp, so_5/dispatcher_restarts/main.cpp, so_5/hello_delay/main.cpp, so_5/hello_periodic/main.cpp, so_5/intercom_statechart/main.cpp, so_5/machine_control/main.cpp, so_5/make_agent_ref/main.cpp, so_5/make_new_direct_mbox/main.cpp, so_5/make_pipeline/main.cpp, so_5/many_timers/main.cpp, so_5/mchain_handler_formats/main.cpp, so_5/named_dispatchers_layer/main.cpp, so_5/news_board/main.cpp, so_5/nohandler_msg_tracing/main.cpp, so_5/parent_coop/main.cpp, so_5/ping_pong/main.cpp, so_5/ping_pong_minimal/main.cpp, so_5/ping_pong_with_owner/main.cpp, so_5/prio_work_stealing/main.cpp, so_5/producer_consumer_mchain/main.cpp, so_5/queue_size_stats/main.cpp, so_5/redirect_and_transform/main.cpp, so_5/selective_msg_tracing/main.cpp, so_5/simple_message_deadline/main.cpp, so_5/state_deep_history/main.cpp, so_5/stop_guard/main.cpp, so_5/two_handlers/main.cpp, and so_5/wrapped_env_demo_3/main.cpp.

Constructor & Destructor Documentation

signal_t() [1/3]

so_5::signal_t::signal_t ( const signal_t &  )

privatedelete

signal_t() [2/3]

so_5::signal_t::signal_t ( signal_t &&  )

privatedelete

signal_t() [3/3]

so_5::signal_t::signal_t ( )

privatedefault

Private constructor to disable creation of instances of derived classes.

~signal_t()

so_5::signal_t::~signal_t ( )

overridedefaultnoexcept

Member Function Documentation

operator=() [1/2]

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

privatedelete

operator=() [2/2]

signal_t& so_5::signal_t::operator= ( signal_t &&  )

privatedelete

so5_message_kind()

kind_t so_5::signal_t::so5_message_kind ( ) const

inlineoverrideprivatevirtualnoexcept

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 from so_5::message_t.

---

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

• message.hpp