wait_indication.hpp
Go to the documentation of this file.
2 * SObjectizer-5
3 */
6 * \since
7 * v.5.5.13
8 *
9 * \file
10 * \brief Definition of various types of waiting indicators.
11 */
18 * \since
19 * v.5.5.13
20 *
21 * \brief A type for special marker for infitite waiting on service request
22 * or on receive from %mchain.
23 */
27 * \since
28 * v.5.5.13
29 *
30 * \brief A special indicator for infinite waiting on service request or
31 * on receive from %mchain.
32 */
37 * \since
38 * v.5.5.13
39 *
40 * \brief A type for special marker for no waiting on service request
41 * or on receive from %mchain.
42 */
46 * \since
47 * v.5.5.13
48 *
49 * \brief A special indicator for no waiting on service request or
50 * on receive from %mchain.
51 */
virtual void unsubscribe_event_handler(const std::type_index &type_index, abstract_message_sink_t &subscriber) noexcept=0
Remove all message handlers.
virtual void subscribe_event_handler(const std::type_index &type_index, abstract_message_sink_t &subscriber)=0
Add the message handler.
virtual so_5::environment_t & environment() const noexcept=0
SObjectizer Environment for which the mbox is created.
abstract_message_box_t()=default
abstract_message_box_t(const abstract_message_box_t &)=delete
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.
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 ~abstract_message_box_t() noexcept=default
abstract_message_box_t & operator=(abstract_message_box_t &&)=delete
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.
abstract_message_box_t & operator=(const abstract_message_box_t &)=delete
abstract_message_box_t(abstract_message_box_t &&)=delete
agent_context_t(environment_t &env, agent_tuning_options_t options)
Definition agent_context.hpp:41
const agent_tuning_options_t & options() const
Read-only access to agent options.
Definition agent_context.hpp:87
agent_context_t(environment_t &env)
Constructor for the case when only environment available.
Definition agent_context.hpp:33
environment_t & environment() const
Access to SObjectizer Environment.
Definition agent_context.hpp:73
agent_tuning_options_t & options()
Read-Write access to agent options.
Definition agent_context.hpp:80
friend void swap(so_5::agent_context_t &a, so_5::agent_context_t &b) noexcept
Swap operation.
Definition agent_context.hpp:52
Helper class for holding agent's identity (name or pointer).
Definition agent_identity.hpp:49
agent_identity_t(const agent_t *pointer) noexcept
Initializing constructor for case when agent has no user specified name.
Definition agent_identity.hpp:139
Interface of the agent state listener.
Definition agent_state_listener.hpp:41
Type for holding information necessary for handling time limits for agent states.
Definition agent.hpp:3019
~state_time_limit_handling_data_t()
bool is_defined() const noexcept
Is the data for handling time limits defined?
Definition agent.cpp:692
state_time_limit_handling_data_t()
Definition agent.cpp:685
mbox_t m_timeout_mbox
Definition agent.hpp:3026
mbox_t timeout_mbox() const noexcept
Definition agent.cpp:705
void make_defined(mbox_t timeout_mbox)
Definition agent.cpp:698
void so_subscribe_deadletter_handler(const so_5::mbox_t &mbox, Event_Handler &&handler, thread_safety_t thread_safety=thread_safety_t::unsafe)
Create a subscription for deadletter handler for a specific message from a specific mbox.
Definition agent.hpp:2125
static demand_handler_pfn_t get_demand_handler_on_start_ptr() noexcept
Definition agent.cpp:1461
impl::state_listener_controller_t m_state_listener_controller
State listeners controller.
Definition agent.hpp:2854
decltype(auto) so_low_level_exec_as_event_handler(Lambda &&lambda) noexcept(noexcept(lambda()))
Helper method that allows to run a block of code as non-thread-safe event handler.
Definition agent.hpp:2675
static void process_enveloped_msg(current_thread_id_t working_thread_id, execution_demand_t &d, const impl::event_handler_data_t *handler_data)
Actual implementation of enveloped message handling.
Definition agent.cpp:1591
std::unique_ptr< impl::sinks_storage_t > m_message_sinks
Holder of message sinks for that agent.
Definition agent.hpp:2894
void do_change_agent_state(const state_t &state_to_be_set)
Perform actual operations related to state switch.
Definition agent.cpp:1791
void so_drop_delivery_filter(const mbox_t &mbox) noexcept
Drop a delivery filter.
Definition agent.hpp:2576
void so_initiate_agent_definition()
A correct initiation of so_define_agent method call.
Definition agent.cpp:963
void evt_state_time_limit(mhood_t< so_5::details::msg_state_timeout >)
Special event handler to process state time limits.
Definition agent.cpp:1945
static const impl::event_handler_data_t * find_deadletter_handler(execution_demand_t &demand)
Search for event handler between deadletter handlers.
Definition agent.cpp:1781
static demand_handler_pfn_t get_demand_handler_on_message_ptr() noexcept
Definition agent.cpp:1526
void so_switch_to_awaiting_deregistration_state()
Switching agent to special state in case of unhandled exception.
Definition agent.cpp:881
static void process_message(current_thread_id_t working_thread_id, execution_demand_t &d, thread_safety_t thread_safety, event_handler_method_t method)
Actual implementation of message handling.
Definition agent.cpp:1550
void so_drop_deadletter_handler(const so_5::mbox_t &mbox)
Drops the subscription for deadletter handler.
Definition agent.hpp:2174
bool so_is_active_state(const state_t &state_to_check) const noexcept
Is a state activated?
Definition agent.cpp:844
void ensure_operation_is_on_working_thread(const char *operation_name) const
Enables operation only if it is performed on agent's working thread.
Definition agent.cpp:1639
static constexpr const state_t::history_t deep_history
Short alias for so_5::state_t::history_t::deep.
Definition agent.hpp:737
@ shutdown_with_skipping_pending_demands
Agent was shutdown and all pending demands have to be skipped.
@ not_defined_yet
@ state_switch_in_progress
State switch operation is in progress.
void destroy_all_subscriptions_and_filters() noexcept
Destroy all agent's subscriptions.
Definition agent.cpp:1143
void ensure_binding_finished()
Ensures that all agents from cooperation are bound to dispatchers.
Definition agent.cpp:1452
disp_binder_shptr_t so_this_agent_disp_binder() const
Returns the dispatcher binder that is used for binding this agent.
Definition agent.hpp:2716
void so_set_delivery_filter(const mbox_t &mbox, Lambda &&lambda)
Set a delivery filter.
Definition agent.hpp:3577
bool do_check_subscription_presence(const mbox_t &mbox, const std::type_index &msg_type, const state_t &target_state) const noexcept
Check the presence of a subscription.
Definition agent.cpp:1337
void do_state_switch(const state_t &state_to_be_set) noexcept
Actual action for switching agent state.
Definition agent.cpp:1832
std::unique_ptr< impl::delivery_filter_storage_t > m_delivery_filters
Delivery filters for that agents.
Definition agent.hpp:2962
void return_to_default_state_if_possible() noexcept
Return agent to the default state.
Definition agent.cpp:1895
subscription_bind_t so_subscribe_self()
Initiate subscription to agent's direct mbox.
Definition agent.hpp:1461
void do_set_delivery_filter(const mbox_t &mbox, const std::type_index &msg_type, delivery_filter_unique_ptr_t filter)
Set a delivery filter.
Definition agent.cpp:1674
static void call_push_event(agent_t &agent, const message_limit::control_block_t *limit, mbox_id_t mbox_id, const std::type_index &msg_type, const message_ref_t &message)
Push an event to the agent's event queue.
Definition agent.hpp:1070
static execution_hint_t so_create_execution_hint(execution_demand_t &demand)
Create execution hint for the specified demand.
Definition agent.cpp:1035
void so_change_state(const state_t &new_state)
Change the current state of the agent.
Definition agent.cpp:936
void push_event(const message_limit::control_block_t *limit, mbox_id_t mbox_id, const std::type_index &msg_type, const message_ref_t &message)
Push event into the event queue.
Definition agent.cpp:1403
static custom_direct_mbox_factory_t custom_direct_mbox_factory(Lambda &&lambda)
Helper for creation a custom direct mbox factory.
Definition agent.hpp:1168
void so_deregister_agent_coop_normally()
A helper method for deregistering agent's coop in case of normal deregistration.
Definition agent.cpp:1116
void do_drop_delivery_filter(const mbox_t &mbox, const std::type_index &msg_type) noexcept
Drop a delivery filter.
Definition agent.cpp:1702
virtual exception_reaction_t so_exception_reaction() const noexcept
A reaction from SObjectizer to an exception from agent's event.
Definition agent.cpp:871
disp_binder_shptr_t so_this_coop_disp_binder() const
Returns the dispatcher binder that is used as the default binder for the agent's coop.
Definition agent.cpp:1122
abstract_message_sink_t & detect_sink_for_message_type(const std::type_index &msg_type)
Helper function that returns a message sink to be used for subscriptions for specified message type.
Definition agent.cpp:1291
const demands_handling_on_dereg_t m_demands_handling_on_dereg
What to do with pending demands on deregistration.
Definition agent.hpp:3085
static void demand_handler_on_message(current_thread_id_t working_thread_id, execution_demand_t &d)
Calls event handler for message.
Definition agent.cpp:1509
static constexpr const state_t::history_t shallow_history
Short alias for so_5::state_t::history_t::shallow.
Definition agent.hpp:730
void so_drop_all_subscriptions_and_filters()
Dropping all agents subscriptions and filters.
Definition agent.cpp:954
static demand_handler_pfn_t get_demand_handler_on_finish_ptr() noexcept
Definition agent.cpp:1503
void so_add_nondestroyable_listener(agent_state_listener_t &state_listener)
Add a state listener to the agent.
Definition agent.cpp:853
static const impl::event_handler_data_t * handler_finder_msg_tracing_disabled(execution_demand_t &demand, const char *context_marker)
Handler finder for the case when message delivery tracing is disabled.
Definition agent.cpp:1713
bool so_has_deadletter_handler(const so_5::mbox_t &mbox) const noexcept
Checks the presence of deadletter handler for a message of a specific type from a specific mbox.
Definition agent.hpp:2215
agent_identity_t so_agent_name() const noexcept
Get an optional name of the agent.
Definition agent.cpp:1134
static const impl::event_handler_data_t * handler_finder_msg_tracing_enabled(execution_demand_t &demand, const char *context_marker)
Handler finder for the case when message delivery tracing is enabled.
Definition agent.cpp:1726
static const impl::event_handler_data_t * find_event_handler_for_current_state(execution_demand_t &demand)
Actual search for event handler with respect to parent-child relationship between agent states.
Definition agent.cpp:1760
static void demand_handler_on_start(current_thread_id_t working_thread_id, execution_demand_t &d)
Calls so_evt_start method for agent.
Definition agent.cpp:1425
impl::subscription_storage_unique_ptr_t m_subscriptions
All agent's subscriptions.
Definition agent.hpp:2881
void so_destroy_deadletter_subscription(const mbox_t &mbox, const std::type_index &msg_type)
Destroy a subscription for a deadletter handler.
Definition agent.cpp:1277
static void demand_handler_on_finish(current_thread_id_t working_thread_id, execution_demand_t &d)
Calls so_evt_finish method for agent.
Definition agent.cpp:1467
bool do_check_deadletter_presence(const mbox_t &mbox, const std::type_index &msg_type) const noexcept
Check the presence of a deadletter handler.
Definition agent.cpp:1347
void do_drop_subscription_for_all_states(const mbox_t &mbox, const std::type_index &msg_type)
Remove subscription for all states.
Definition agent.cpp:1322
agent_t(context_t ctx)
Constructor which simplifies agent construction with or without agent's tuning options.
Definition agent.cpp:788
static agent_tuning_options_t tuning_options()
Create tuning options object with default values.
Definition agent.hpp:1136
void so_add_destroyable_listener(agent_state_listener_unique_ptr_t state_listener)
Add a state listener to the agent.
Definition agent.cpp:862
environment_t & so_environment() const noexcept
Access to the SObjectizer Environment which this agent is belong.
Definition agent.cpp:987
const state_t & so_default_state() const
Access to the agent's default state.
Definition agent.cpp:900
subscription_bind_t so_subscribe(const mbox_t &mbox_ref)
Initiate subscription.
Definition agent.hpp:1404
state_time_limit_handling_data_t m_state_time_limit_handling_data
Data that is necessary for handling time limits of agent's states.
Definition agent.hpp:3077
void so_bind_to_dispatcher(event_queue_t &queue) noexcept
Binding agent to the dispatcher.
Definition agent.cpp:1006
void so_destroy_event_subscription(const mbox_t &mbox, const std::type_index &subscription_type, const state_t &target_state)
Destroy event subscription.
Definition agent.hpp:1506
void so_set_delivery_filter_for_mutable_msg(const mbox_t &mbox, Lambda &&lambda)
Set a delivery filter for a mutable message.
Definition agent.hpp:3600
environment_t & m_env
SObjectizer Environment for which the agent is belong.
Definition agent.hpp:2897
void so_deregister_agent_coop(int dereg_reason)
A helper method for deregistering agent's coop.
Definition agent.cpp:1109
void do_drop_subscription(const mbox_t &mbox, const std::type_index &msg_type, const state_t &target_state)
Remove subscription for the state specified.
Definition agent.cpp:1307
agent_t(environment_t &env, agent_tuning_options_t tuning_options)
Constructor which allows specification of agent's tuning options.
Definition agent.cpp:781
void define_state_time_limit_handling_data_if_needed()
Initialize data for handling time limit of agent's states.
Definition agent.cpp:1913
static demand_handler_pfn_t get_demand_handler_on_enveloped_msg_ptr() noexcept
Definition agent.cpp:1544
void so_create_event_subscription(const mbox_t &mbox_ref, std::type_index type_index, const state_t &target_state, const event_handler_method_t &method, thread_safety_t thread_safety, event_handler_kind_t handler_kind)
Create a subscription for an event.
Definition agent.cpp:1221
void so_set_delivery_filter(const mbox_t &mbox, delivery_filter_unique_ptr_t filter)
Set a delivery filter.
Definition agent.hpp:2471
static void demand_handler_on_enveloped_msg(current_thread_id_t working_thread_id, execution_demand_t &d)
Handles the enveloped message.
Definition agent.cpp:1532
A collector for agent tuning options.
Definition agent_tuning_options.hpp:228
so_5::priority_t query_priority() const noexcept
Get priority value.
Definition agent_tuning_options.hpp:330
bool m_is_user_provided_subscription_storage_factory
Does a user provide a specific subscription_storage_factory?
Definition agent_tuning_options.hpp:466
agent_tuning_options_t & agent_name(name_for_agent_t name)
Set a name for agent.
Definition agent_tuning_options.hpp:375
subscription_storage_factory_t m_subscription_storage_factory
Definition agent_tuning_options.hpp:438
name_for_agent_t giveout_agent_name() noexcept
Gives away the name for an agent.
Definition agent_tuning_options.hpp:407
friend void swap(so_5::agent_tuning_options_t &a, so_5::agent_tuning_options_t &b) noexcept
Definition agent_tuning_options.hpp:233
message_limit::description_container_t m_message_limits
Definition agent_tuning_options.hpp:441
demands_handling_on_dereg_t m_demands_handling_on_dereg
What to do with pending demands on deregistration.
Definition agent_tuning_options.hpp:478
bool has_agent_name() const noexcept
Does a name specified for an agent?
Definition agent_tuning_options.hpp:393
agent_tuning_options_t()=default
agent_tuning_options_t & custom_direct_mbox_factory(custom_direct_mbox_factory_t factory)
Set custom direct mbox factory.
Definition agent_tuning_options.hpp:341
const custom_direct_mbox_factory_t & query_custom_direct_mbox_factory() const noexcept
Get a reference to custom direct mbox factory.
Definition agent_tuning_options.hpp:360
bool is_user_provided_subscription_storage_factory() const noexcept
Does a user provide a specific subscription_storage_factory?
Definition agent_tuning_options.hpp:285
static subscription_storage_factory_t default_subscription_storage_factory()
Default subscription storage factory.
Definition agent_tuning_options.hpp:293
const subscription_storage_factory_t & query_subscription_storage_factory() const noexcept
Definition agent_tuning_options.hpp:270
agent_tuning_options_t & message_limits(Args &&... args)
Definition agent_tuning_options.hpp:307
demands_handling_on_dereg_t demands_handling_on_dereg() const noexcept
Definition agent_tuning_options.hpp:428
agent_tuning_options_t & subscription_storage_factory(subscription_storage_factory_t factory) noexcept(noexcept(std::declval< subscription_storage_factory_t & >()=std::move(factory)))
Set factory for subscription storage creation.
Definition agent_tuning_options.hpp:253
message_limit::description_container_t giveout_message_limits()
Definition agent_tuning_options.hpp:300
agent_tuning_options_t & demands_handling_on_dereg(demands_handling_on_dereg_t handling_mode)
Set mode of handling pending demands on deregistration.
Definition agent_tuning_options.hpp:416
agent_tuning_options_t & priority(so_5::priority_t v)
Set priority for agent.
Definition agent_tuning_options.hpp:321
custom_direct_mbox_factory_t m_custom_direct_mbox_factory
Optional factory for custom direct mboxes.
Definition agent_tuning_options.hpp:456
The base class for the object with a reference counting.
Definition atomic_refcounted.hpp:35
atomic_refcounted_t(const atomic_refcounted_t &)=delete
atomic_refcounted_t & operator=(const atomic_refcounted_t &)=delete
It's a kind of strong typedef for coop's deregistration reason.
Definition coop.hpp:80
exception_reaction_t exception_reaction() const noexcept
Get the current exception rection flag for that cooperation.
Definition coop.hpp:758
delivery_filter_t(delivery_filter_t &&)=delete
virtual bool check(const abstract_message_sink_t &receiver, message_t &msg) const noexcept=0
Checker for a message instance.
delivery_filter_t & operator=(delivery_filter_t &&)=delete
delivery_filter_t(const delivery_filter_t &)=delete
virtual ~delivery_filter_t() noexcept=default
delivery_filter_t()=default
delivery_filter_t & operator=(const delivery_filter_t &)=delete
Helper template class for do rollback actions automatically in the destructor.
Definition rollback_on_exception.hpp:32
L & m_action
Definition rollback_on_exception.hpp:33
void commit()
Definition rollback_on_exception.hpp:40
~rollbacker_t()
Definition rollback_on_exception.hpp:38
rollbacker_t(L &action)
Definition rollback_on_exception.hpp:37
bool m_commited
Definition rollback_on_exception.hpp:34
Helper class for scope exit implementation.
Definition at_scope_exit.hpp:30
at_exit_t(L &&l)
Definition at_scope_exit.hpp:33
at_exit_t(at_exit_t &&o)
Definition at_scope_exit.hpp:34
An implementation of handler_invoker interface.
Definition enveloped_msg_details.hpp:75
Parameters for the SObjectizer Environment initialization.
Definition environment.hpp:98
void deregister_coop(coop_handle_t coop, int reason) noexcept
Deregister the cooperation.
Definition environment.hpp:1556
error_logger_t & operator=(error_logger_t &)=delete
virtual ~error_logger_t() noexcept=default
error_logger_t(const error_logger_t &)=delete
error_logger_t()=default
virtual void log(const char *file_name, unsigned int line, const std::string &message)=0
A method for logging message.
exception_t(const exception_t &)=default
exception_t(exception_t &&)=default
exception_t(const std::string &error_descr, int error_code)
Definition exception.hpp:36
exception_t & operator=(exception_t &&o) noexcept=default
exception_t & operator=(exception_t &o)=default
static void raise(const char *file_name, unsigned int line_number, std::string_view error_descr, int error_code)
Definition exception.cpp:17
A hint for a dispatcher for execution of event for the concrete execution_demand.
Definition execution_demand.hpp:130
static execution_hint_t create_empty_execution_hint(execution_demand_t &demand)
Definition execution_demand.hpp:174
A special class for accessing private members of agent_coop.
Definition coop_private_iface.hpp:33
static void decrement_usage_count(coop_t &coop)
Definition coop_private_iface.hpp:67
static void increment_usage_count(coop_t &coop) noexcept
Definition coop_private_iface.hpp:61
Storage for message delivery filters.
Definition delivery_filter_storage.hpp:44
A helper class for accessing the functionality of environment-class which is specific for SObjectizer...
Definition internal_env_iface.hpp:36
event_queue_t * event_queue_on_bind(agent_t *agent, event_queue_t *original_queue) noexcept
Call the event_queue_hook when an agent is being bound to a particular event_queue.
Definition environment.cpp:982
void event_queue_on_unbind(agent_t *agent, event_queue_t *queue) noexcept
Call the event_queue_hook when an agent is being unbound from its event_queue.
Definition environment.cpp:990
bool is_msg_tracing_enabled() const
Is message delivery tracing enabled?
Definition environment.cpp:945
internal_env_iface_t(environment_t &env)
Initializing constructor.
Definition internal_env_iface.hpp:42
mbox_t create_limitless_mpsc_mbox(agent_t &single_consumer)
Create multi-producer/single-consumer mbox that ignores message limits.
Definition environment.cpp:917
Helper class for accessing protected members from mbox interface.
Definition mbox_iface_for_timers.hpp:31
An interface for storage of message_sinks for one agent.
Definition std_message_sinks.hpp:39
~state_switch_guard_t()
Definition agent.cpp:927
agent_t::agent_status_t m_previous_status
Definition agent.cpp:910
state_switch_guard_t(agent_t &agent)
Definition agent.cpp:913
An interface of subscription storage.
Definition subscription_storage_iface.hpp:159
Template class for smart reference wrapper on the atomic_refcounted_t.
Definition atomic_refcounted.hpp:93
bool operator==(const intrusive_ptr_t &o) const
Definition atomic_refcounted.hpp:267
void dismiss_object() noexcept
Decrement reference count to object and delete it if needed.
Definition atomic_refcounted.hpp:295
intrusive_ptr_t(const intrusive_ptr_t< Y > &o) noexcept
Constructor from another smart reference.
Definition atomic_refcounted.hpp:140
intrusive_ptr_t(std::unique_ptr< Y > o) noexcept
Constructor from unique_ptr instance.
Definition atomic_refcounted.hpp:155
bool operator<(const intrusive_ptr_t &o) const
Definition atomic_refcounted.hpp:273
T * operator->() const noexcept
Definition atomic_refcounted.hpp:247
intrusive_ptr_t(const intrusive_ptr_t &o) noexcept
Copy constructor.
Definition atomic_refcounted.hpp:119
intrusive_ptr_t & operator=(const intrusive_ptr_t &o) noexcept
Copy operator.
Definition atomic_refcounted.hpp:179
intrusive_ptr_t & operator=(intrusive_ptr_t &&o) noexcept
Move operator.
Definition atomic_refcounted.hpp:188
intrusive_ptr_t< Y > make_reference() const noexcept
Make reference with casing to different type.
Definition atomic_refcounted.hpp:215
void take_object() noexcept
Increment reference count to object if it's not null.
Definition atomic_refcounted.hpp:287
static void ensure_right_T()
Definition atomic_refcounted.hpp:94
friend void swap(intrusive_ptr_t &a, intrusive_ptr_t &b) noexcept
Swap values.
Definition atomic_refcounted.hpp:171
error_logger_t & m_logger
Definition error_logger.hpp:125
std::ostringstream & stream()
Definition error_logger.hpp:115
std::ostringstream m_stream
Definition error_logger.hpp:129
conductor_t(const Env &env, const char *file, unsigned int line)
Definition error_logger.hpp:103
conductor_t(error_logger_t &logger, const char *file, unsigned int line)
Definition error_logger.hpp:93
An implementation of delivery filter represented by lambda-function like object.
Definition mbox.hpp:126
lambda_as_filter_t(Lambda &&filter)
Definition mbox.hpp:130
bool check(const abstract_message_sink_t &, message_t &msg) const noexcept override
Checker for a message instance.
Definition mbox.hpp:135
any_unspecified_message()
Definition message.cpp:53
~any_unspecified_message()
Definition message.cpp:52
An interface of tracer for message delivery tracing.
Definition message_limit_action_msg_tracer.hpp:33
virtual void so5_change_mutability(message_mutability_t mutability)
Change message mutabilty flag.
Definition message.hpp:228
message_t & operator=(message_t &&other) noexcept
Definition message.cpp:39
friend message_mutability_t message_mutability(const message_t &what) noexcept
Helper method for get message mutability flag.
Definition message.hpp:86
virtual kind_t so5_message_kind() const noexcept
Detect the kind of the message.
Definition message.hpp:248
virtual ~message_t() noexcept=default
friend message_kind_t message_kind(const message_t &what)
Helper method for quering kind of the message.
Definition message.hpp:174
friend message_mutability_t message_mutability(const intrusive_ptr_t< message_t > &what) noexcept
Helper method for safe get of message mutability flag.
Definition message.hpp:74
virtual message_mutability_t so5_message_mutability() const noexcept
Get message mutability flag.
Definition message.hpp:203
friend void change_message_mutability(message_t &what, message_mutability_t mutability)
Helper method for change message mutability flag.
Definition message.hpp:130
friend message_kind_t message_kind(const so_5::intrusive_ptr_t< message_t > &what)
Helper method for quering kind of the message.
Definition message.hpp:154
friend void change_message_mutability(intrusive_ptr_t< message_t > &what, message_mutability_t mutability)
Helper method for safe change message mutability flag.
Definition message.hpp:107
A message wrapped to be used as type of argument for event handlers.
Definition mhood.hpp:570
name_for_agent_t & operator=(name_for_agent_t &&other) noexcept
Definition agent.cpp:142
name_for_agent_t(const name_for_agent_t &)
Definition agent.cpp:115
name_for_agent_t(name_for_agent_t &&other) noexcept
Definition agent.cpp:136
name_for_agent_t & operator=(const name_for_agent_t &)
Definition agent.cpp:129
~name_for_agent_t()
Helper class for indication of long-lived reference via its type.
Definition outliving.hpp:98
outliving_reference_t(T &r) noexcept
Definition outliving.hpp:104
outliving_reference_t & operator=(outliving_reference_t const &o)=delete
outliving_reference_t(outliving_reference_t< U > const &o) noexcept
Definition outliving.hpp:112
outliving_reference_t(T &&)=delete
outliving_reference_t(outliving_reference_t const &o) noexcept
Definition outliving.hpp:107
Wrapper around a pointer to partially constructed agent.
Definition agent_tuning_options.hpp:34
partially_constructed_agent_ptr_t(agent_t *ptr)
Definition agent_tuning_options.hpp:38
agent_t * ptr() const noexcept
Definition agent_tuning_options.hpp:44
An implementation of backoff object using assembly instruction.
Definition spinlocks.hpp:60
read_lock_guard_t(const read_lock_guard_t &)=delete
read_lock_guard_t & operator=(const read_lock_guard_t &)=delete
A simple multi-readers/single-writer spinlock (analog of std::shared_mutex).
Definition spinlocks.hpp:152
static constexpr const std::uint_fast32_t unlocked
Definition spinlocks.hpp:156
static constexpr const std::uint_fast32_t write_lock
Definition spinlocks.hpp:157
static constexpr const std::uint_fast32_t read_lock
Definition spinlocks.hpp:158
rw_spinlock_t & operator=(const rw_spinlock_t &)=delete
rw_spinlock_t(const rw_spinlock_t &)=delete
signal_t(const signal_t &)=delete
signal_t(signal_t &&)=delete
signal_t & operator=(signal_t &&)=delete
kind_t so5_message_kind() const noexcept override
Detect the kind of the message.
Definition message.hpp:293
signal_t & operator=(const signal_t &)=delete
~signal_t() noexcept override=default
signal_t()=default
spinlock_t(const spinlock_t &)=delete
spinlock_t & operator=(spinlock_t &&)=delete
spinlock_t & operator=(const spinlock_t &)=delete
spinlock_t(spinlock_t &&)=delete
Helper class for simplify iteration on state's path.
Definition state.hpp:1841
void change(duration_t limit, const state_t &state_to_switch) noexcept
Definition agent.cpp:224
const state_t & state_to_switch() const noexcept
Definition agent.cpp:314
void on_state_activation(const agent_t::state_time_limit_handling_data_t &info) noexcept
Definition agent.cpp:243
bool is_limit_exceeded(const steady_clock::time_point current_time) const noexcept
Definition agent.cpp:300
std::optional< activation_data_t > m_activation_data
Definition agent.cpp:355
std::reference_wrapper< const state_t > m_state_to_switch
The target state to switch after the timeout.
Definition agent.cpp:350
void activate(const agent_t::state_time_limit_handling_data_t &info)
Definition agent.cpp:268
time_limit_t(duration_t limit, const state_t &state_to_switch) noexcept
Initializing constructor.
Definition agent.cpp:208
void on_state_deactivation() noexcept
Definition agent.cpp:254
bool is_target(const agent_t *agent) const noexcept
Is agent owner of this state?
Definition agent.cpp:552
state_t & time_limit(duration_t timeout, const state_t &state_to_switch)
Set up a time limit for the state.
Definition agent.cpp:569
std::enable_if< details::is_agent_method_pointer< details::method_arity::nullary, Method_Pointer >::value, state_t & >::type on_enter(Method_Pointer pfn)
Set on enter handler.
Definition agent.hpp:4042
state_t(initial_substate_of parent, std::string state_name, history_t state_history)
Constructor for the case when state is the initial substate of some parent state.
Definition agent.cpp:427
state_t(substate_of parent)
Constructor for the case when state is a substate of some parent state.
Definition agent.cpp:447
bool is_active() const noexcept
Is this state or any of its substates activated?
Definition agent.hpp:3918
state_t(agent_t *target_agent, std::string state_name, state_t *parent_state, std::size_t nested_level, history_t state_history)
Fully initializing constructor.
Definition agent.cpp:362
state_t(agent_t *agent, std::string state_name, history_t state_history)
Definition agent.cpp:409
state_t(substate_of parent, std::string state_name, history_t state_history)
Constructor for the case when state is a substate of some parent state.
Definition agent.cpp:458
const state_t * actual_state_to_enter() const
Find actual state to be activated for agent.
Definition agent.cpp:626
state_t(initial_substate_of parent)
Constructor for the case when state is the initial substate of some parent state.
Definition agent.cpp:416
bool operator==(const state_t &state) const noexcept
Definition agent.cpp:492
state_t(initial_substate_of parent, std::string state_name)
Constructor for the case when state is the initial substate of some parent state.
Definition agent.cpp:421
bool operator!=(const state_t &state) const noexcept
Definition state.hpp:360
state_t(substate_of parent, std::string state_name)
Constructor for the case when state is a substate of some parent state.
Definition agent.cpp:452
void handle_time_limit_on_enter() const
A special handler of time limit to be used on entering into state.
Definition agent.cpp:670
void update_history_in_parent_states() const
A helper method which is used during state change for update state with history.
Definition agent.cpp:649
void handle_time_limit_on_exit() const
A special handler of time limit to be used on exiting from state.
Definition agent.cpp:677
A class for creating a subscription to messages from the mbox.
Definition agent.hpp:174
subscription_bind_t & just_switch_to(const state_t &target_state)
Define handler which only switches agent to the specified state.
Definition agent.hpp:3856
void create_subscription_for_states(const std::type_index &msg_type, const event_handler_method_t &method, thread_safety_t thread_safety, event_handler_kind_t handler_kind) const
Create subscription of event for all states.
Definition agent.hpp:3879
subscription_bind_t(agent_t &agent, const mbox_t &mbox_ref)
Definition agent.hpp:3627
subscription_bind_t & in(const state_t &state)
Set up a state in which events are allowed be processed.
Definition agent.hpp:3636
subscription_bind_t & suppress()
Suppress processing of event in this state.
Definition agent.hpp:3832
subscription_bind_t & transfer_to_state(const state_t &target_state)
An instruction for switching agent to the specified state and transfering event proceessing to new st...
Definition agent.hpp:3699
void ensure_handler_can_be_used_with_mbox(const so_5::details::msg_type_and_handler_pair_t &handler) const
Additional check for subscription to a mutable message from MPMC mbox.
Definition agent.hpp:3906
An implementation of backoff object with usage of std::yield.
Definition spinlocks.hpp:38
#define SO_5_LOG_ERROR(logger, var_name)
A special macro for helping error logging.
Definition error_logger.hpp:161
#define SO_5_LOG_ERROR_IMPL(logger, file, line, var_name)
An implementation for SO_5_LOG_ERROR macro.
Definition error_logger.hpp:145
#define SO_5_THROW_EXCEPTION_IMPL(file, line, error_code, desc)
Definition exception.hpp:71
demand_handler_pfn_t select_demand_handler_for_message(const agent_t &agent, const message_ref_t &msg)
A helper function to select actual demand handler in dependency of message kind.
Definition agent.cpp:1365
mbox_t make_direct_mbox_with_respect_to_custom_factory(partially_constructed_agent_ptr_t agent_ptr, const agent_tuning_options_t &tuning_options, mbox_t standard_mbox)
Helper for creation of the direct mbox for an agent.
Definition agent.cpp:722
unsigned int ensure_valid_agent_name_length(std::size_t length)
Definition agent.cpp:83
std::string create_anonymous_state_name(const agent_t *agent, const state_t *st)
Definition agent.cpp:183
const state_t deadletter_state(nullptr, "<DEADLETTER_STATE>")
A special object to be used as state for make subscriptions for deadletter handlers.
subscription_storage_factory_t detect_subscription_storage_factory_to_use(environment_t &env, const agent_tuning_options_t &tuning_options)
Helper for selection of subscription storage factory.
Definition agent.cpp:759
const state_t awaiting_deregistration_state(nullptr, "<AWAITING_DEREGISTRATION_AFTER_UNHANDLED_EXCEPTION>")
A special object for the state in which agent is awaiting for deregistration after unhandled exceptio...
Implementation details for implementation of rollback on exception helper.
Definition rollback_on_exception.hpp:19
Some reusable and low-level classes/functions which can be used in public header files.
Definition environment.hpp:2094
auto make_message_instance(Args &&... args) -> std::unique_ptr< typename message_payload_type< Msg >::envelope_type >
A helper for allocate instance of a message.
Definition message.hpp:841
auto do_with_rollback_on_exception(Main_Action main_action, Rollback_Action rollback_action) -> decltype(main_action())
Helper function for do some action with rollback in the case of an exception.
Definition rollback_on_exception.hpp:85
scope_exit_details::at_exit_t< L > at_scope_exit(L &&l)
Helper function for creation action to be performed at scope exit.
Definition at_scope_exit.hpp:60
Definition enveloped_msg.hpp:20
Internal namespace with details of agent_t implementation.
Definition agent.hpp:462
Various helpers for message delivery tracing mechanism.
Definition msg_tracing_helpers.hpp:39
void safe_trace_state_leaving(const agent_t &state_owner, const state_t &state)
Helper for tracing the fact of leaving a state.
Definition msg_tracing_helpers.hpp:861
void safe_trace_state_entering(const agent_t &state_owner, const state_t &state)
Helper for tracing the fact of entering into a state.
Definition msg_tracing_helpers.hpp:884
void trace_deadletter_handler_search_result(const execution_demand_t &demand, const char *context_marker, const event_handler_data_t *search_result)
Helper for tracing the result of search of deadletter handler.
Definition msg_tracing_helpers.hpp:836
void trace_event_handler_search_result(const execution_demand_t &demand, const char *context_marker, const event_handler_data_t *search_result)
Helper for tracing the result of event handler search.
Definition msg_tracing_helpers.hpp:814
Implementation details of error_logging facility.
Definition error_logger.hpp:87
Definition mbox.hpp:99
void ensure_not_null(const delivery_filter_unique_ptr_t &ptr)
Helper function that throws if a pointer to delivery_filter is null.
Definition mbox.hpp:107
void deliver_message(message_delivery_mode_t delivery_mode, abstract_message_box_t &target, std::type_index subscription_type, message_ref_t msg)
Deliver message.
Definition mbox.hpp:413
void deliver_signal(message_delivery_mode_t delivery_mode, abstract_message_box_t &target)
Deliver signal.
Definition mbox.hpp:445
void deliver_message(message_delivery_mode_t delivery_mode, abstract_message_box_t &target, std::type_index subscription_type, std::unique_ptr< Message > msg)
Deliver message.
Definition mbox.hpp:379
Internal implementation of message limits related stuff.
Definition message.hpp:883
action_t make_action_for_message_transformer(Lambda &&transformator)
Helper function to make an action that performs message transformation.
Definition message_limit.hpp:429
SO_5_FUNC void redirect_reaction(const overlimit_context_t &ctx, const mbox_t &to)
Actual implementation of redirect message reaction.
Definition message_limit.cpp:65
SO_5_FUNC void abort_app_reaction(const overlimit_context_t &ctx)
Actual implementation of abort application reaction.
Definition message_limit.cpp:47
SO_5_FUNC void drop_message_reaction(const overlimit_context_t &ctx)
Actual implementation of drop message reaction.
Definition message_limit.cpp:39
action_t make_action_for_signal_transformer(Lambda &&transformator)
Helper function to make an action that performs signal transformation.
Definition message_limit.hpp:491
SO_5_FUNC void transform_reaction(const overlimit_context_t &ctx, const mbox_t &to, const std::type_index &msg_type, const message_ref_t &message)
Actual implementation of transform reaction.
Definition message_limit.cpp:106
void accept_one_indicator(description_container_t &to, const log_then_abort_app_indicator_t< M, L > &indicator)
Helper function for accepting log_then_abort_app_indicator and storing the corresponding description ...
Definition message_limit.hpp:293
void accept_indicators(description_container_t &)
Definition message_limit.hpp:601
void accept_indicators(description_container_t &to, I &&indicator, Args &&... others)
Helper function for constructing limits description from a series of limit indicators.
Definition message_limit.hpp:590
void accept_one_indicator(description_container_t &to, const drop_indicator_t< M > &indicator)
Helper function for accepting drop_indicator and storing the corresponding description into the limit...
Definition message_limit.hpp:127
void accept_one_indicator(description_container_t &to, transform_indicator_t< M > indicator)
Helper function for accepting transform_indicator and storing the corresponding description into the ...
Definition message_limit.hpp:567
void accept_one_indicator(description_container_t &to, const abort_app_indicator_t< M > &indicator)
Helper function for accepting abort_app_indicator and storing the corresponding description into the ...
Definition message_limit.hpp:183
void accept_one_indicator(description_container_t &to, redirect_indicator_t< Msg, Lambda > indicator)
Helper function for accepting redirect_indicator and storing the corresponding description into the l...
Definition message_limit.hpp:371
const int rc_nullptr_as_result_of_user_mbox_factory
nullptr returned by user-provided mbox factory.
Definition ret_code.hpp:468
SO_5_FUNC subscription_storage_factory_t flat_set_based_subscription_storage_factory(std::size_t initial_capacity)
Factory for subscription storage based on sorted std::vector.
Definition subscr_storage_flat_set_based.cpp:526
const int rc_layer_not_binded_to_so_env
The layer is not bound to the SObjectizer Environment.
Definition ret_code.hpp:152
@ ordinary
@ nonblocking
void ensure_message_with_actual_data(const Msg *m)
A special checker to guarantee that the message is an instance of the message_t (not signal_t) and ha...
Definition message.hpp:539
const int rc_state_nesting_is_too_deep
Nesting of agent states is too deep.
Definition ret_code.hpp:59
const int rc_agent_incompatible_type_conversion
It is impossible to make a cast to that type.
Definition ret_code.hpp:36
const int rc_initial_substate_already_defined
Initial substate for a composite state is already defined.
Definition ret_code.hpp:66
SO_5_FUNC subscription_storage_factory_t default_subscription_storage_factory()
Factory for default subscription storage object.
Definition subscr_storage_adaptive.cpp:291
@ multi_producer_single_consumer
@ multi_producer_multi_consumer
const int rc_negative_value_for_pause
An attempt to use negative value for pause argument for delayed or periodic message/signal.
Definition ret_code.hpp:270
const int rc_prepared_select_is_active_now
An attempt to activate prepared-select when an operation on that prepared-select object is already ac...
Definition ret_code.hpp:418
void ensure_not_signal()
A special compile-time checker to guarantee that the message class is not a signal class.
Definition message.hpp:517
const int rc_coop_is_not_in_registered_state
An attempt to do something with coop that is not in registered state.
Definition ret_code.hpp:395
agent_context_t operator+(agent_context_t ctx, message_limit::abort_app_indicator_t< M > limit)
Definition agent_context.hpp:140
const int rc_mutable_msg_cannot_be_periodic
An attempt to send mutable message as a periodic message.
Definition ret_code.hpp:241
const int rc_cannot_set_stop_guard_when_stop_is_started
An attempt to set up a new stop_guard when the stop operation is already in progress.
Definition ret_code.hpp:259
const int rc_no_preallocated_resources_for_agent
There are no resources that must have been in place for an agent in advance.
Definition ret_code.hpp:481
exception_reaction_t
A reaction of SObjectizer to an exception from agent event.
Definition agent.hpp:65
@ inherit_exception_reaction
Exception reaction should be inherited from SO Environment.
Definition agent.hpp:81
@ ignore_exception
Exception should be ignored and agent should continue its work.
Definition agent.hpp:75
SO_5_FUNC error_logger_shptr_t create_stderr_logger()
A factory for creating error_logger implemenation which uses std::stderr as log stream.
Definition error_logger.cpp:96
void ensure_not_mutable_signal()
A special compile-time checker to guarantee that S is not a mutable signal.
Definition message.hpp:563
const int rc_coop_already_destroyed
An attempt to get a pointer to already destroyed cooperation.
Definition ret_code.hpp:384
agent_context_t operator+(agent_context_t ctx, so_5::priority_t agent_priority)
Definition agent_context.hpp:179
demands_handling_on_dereg_t
How pending demands should be handled on deregistration.
Definition agent_tuning_options.hpp:192
const thread_safety_t not_thread_safe
Shorthand for thread unsafety indicator.
Definition types.hpp:62
const int rc_msg_chain_is_full
Attempt to push a message to full message queue.
Definition ret_code.hpp:193
const int rc_operation_enabled_only_on_agent_working_thread
An attempt to perform an operation which is enabled only on agent's working thread.
Definition ret_code.hpp:44
const int rc_autoshutdown_must_be_enabled
An attempt to launch environment with autoshutdown disabled in conditions where autoshutdown must be ...
Definition ret_code.hpp:227
const int rc_scenario_must_be_completed
Testing scenario must be completed before an attempt to do the current operation.
Definition ret_code.hpp:367
const int rc_extensible_select_is_active_now
An attempt to modify or activate extensible-select when an operation on that extensible-select object...
Definition ret_code.hpp:410
message_mutability_t
A enum with variants of message mutability or immutability.
Definition types.hpp:94
@ mutable_message
@ immutable_message
std::thread::id raw_id_from_current_thread_id(const current_thread_id_t &w)
Get the raw thread id from current_thread_id.
Definition current_thread_id.hpp:49
infinite_wait_indication
A type for special marker for infitite waiting on service request or on receive from mchain.
Definition wait_indication.hpp:24
@ infinite_wait
const int rc_trying_to_add_extra_layer_that_already_exists_in_extra_list
The layer is already bound to the SObjectizer Environment as an extra layer.
Definition ret_code.hpp:161
const int rc_several_limits_for_one_message_type
An attempt to define several limits for one message type.
Definition ret_code.hpp:130
const int rc_layer_does_not_exist
A layer with the specified type doesn't exist.
Definition ret_code.hpp:167
const int rc_invalid_time_limit_for_state
Invalid value of time limit for an agent's state.
Definition ret_code.hpp:539
const int rc_agent_to_disp_binding_failed
Binding of agent to dispatcher failed.
Definition ret_code.hpp:81
const int rc_priority_quote_illegal_value
Illegal value of quote for a priority.
Definition ret_code.hpp:174
const int rc_several_handlers_for_one_message_type
Attempt to define several handlers for one msg_type.
Definition ret_code.hpp:206
SO_5_FUNC subscription_storage_factory_t hash_table_based_subscription_storage_factory()
Factory for default subscription storage based on std::unordered_map.
Definition subscr_storage_hash_table_based.cpp:544
const int rc_msg_chain_doesnt_support_subscriptions
Attempt to make subscription for message chain.
Definition ret_code.hpp:196
intrusive_ptr_t< Derived > make_agent_ref(Derived *agent)
Helper function template for the creation of smart pointer to an agent.
Definition agent.hpp:3567
constexpr demands_handling_on_dereg_t skip_demands_on_dereg
Marker that tells that pending demands have to be skipped on deregistration.
Definition agent_tuning_options.hpp:213
const infinite_wait_indication infinite_wait
A special indicator for infinite waiting on service request or on receive from mchain.
Definition wait_indication.hpp:33
const int rc_stored_msg_inspection_result_not_found
There is no stored msg inspection result in the testing scenario.
Definition ret_code.hpp:526
@ classical_message
@ signal
@ enveloped_msg
Message is an envelope with some other message inside.
agent_context_t operator+(agent_context_t ctx, message_limit::drop_indicator_t< M > limit)
Definition agent_context.hpp:130
const int rc_agent_deactivated
Agent can't change state because the agent is already deactivated.
Definition ret_code.hpp:432
no_wait_indication
A type for special marker for no waiting on service request or on receive from mchain.
Definition wait_indication.hpp:43
@ no_wait
SO_5_FUNC void swap(name_for_agent_t &a, name_for_agent_t &b) noexcept
Definition agent.cpp:150
const int rc_stored_state_name_not_found
There is no stored state name in the testing scenario.
Definition ret_code.hpp:374
const int rc_another_state_switch_in_progress
An attempt to switch agent state when another switch operation is in progress.
Definition ret_code.hpp:216
work_thread_activity_tracking_t
Values for dispatcher's work thread activity tracking.
Definition types.hpp:75
@ unspecified
Tracking mode is specified elsewhere.
const no_wait_indication no_wait
A special indicator for no waiting on service request or on receive from mchain.
Definition wait_indication.hpp:52
const int rc_unable_to_define_new_step
New step can't be defined if testing scenario is already started or finished.
Definition ret_code.hpp:359
const int rc_msg_tracing_disabled
Message delivery tracing is disabled and cannot be used.
Definition ret_code.hpp:182
const int rc_unable_to_register_coop_during_shutdown
It is impossible to register cooperation during SObjectizer Environment shutdown.
Definition ret_code.hpp:89
intrusive_ptr_t(std::unique_ptr< T >) -> intrusive_ptr_t< T >
agent_context_t operator+(agent_context_t ctx, demands_handling_on_dereg_t handling_mode)
Definition agent_context.hpp:206
msink_t SO_5_FUNC wrap_to_msink(const mbox_t &mbox, priority_t sink_priority=prio::p0)
Helper for wrapping an existing mbox into message_sink.
Definition mbox.cpp:109
@ disabled_by_delivery_filter
@ no_subscription
@ must_be_delivered
@ hidden_by_envelope
const int rc_no_initial_substate
An attempt to change agent state to a new composite state which have no initial state defined.
Definition ret_code.hpp:52
const int rc_unable_to_join_thread_by_itself
An attempt to call join() from the joinable thread itself.
Definition ret_code.hpp:402
SO_5_FUNC subscription_storage_factory_t adaptive_subscription_storage_factory(std::size_t threshold, const subscription_storage_factory_t &small_storage_factory, const subscription_storage_factory_t &large_storage_factory)
Factory for adaptive subscription storage.
Definition subscr_storage_adaptive.cpp:276
const int rc_illegal_subscriber_for_mpsc_mbox
An attempt to create illegal subscription to mpsc_mbox.
Definition ret_code.hpp:115
const int rc_msg_chain_is_empty
Attempt to get message from empty message queue.
Definition ret_code.hpp:190
outliving_reference_t< const T > outliving_const(T const &r)
Make outliving_reference wrapper for const reference.
Definition outliving.hpp:143
const int rc_unknown_exception_type
An exception of unknown type is caught.
Definition ret_code.hpp:556
void ensure_signal()
A special compile-time checker to guarantee that the Msg is derived from the signal_t.
Definition message.hpp:584
void ensure_classical_message()
A special compile-time checker to guarantee that Msg is derived from message_t.
Definition message.hpp:607
SO_5_FUNC subscription_storage_factory_t vector_based_subscription_storage_factory(std::size_t initial_capacity)
Factory for subscription storage based on unsorted std::vector.
Definition subscr_storage_vector_based.cpp:429
const int rc_msg_chain_doesnt_support_delivery_filters
Attempt to set delivery_filter for message chain.
Definition ret_code.hpp:199
outliving_reference_t< const T > outliving_const(outliving_reference_t< T > r)
Make outliving_reference wrapper for const reference.
Definition outliving.hpp:155
SO_5_FUNC subscription_storage_factory_t map_based_subscription_storage_factory()
Factory for subscription storage based on std::map.
Definition subscr_storage_map_based.cpp:480
SO_5_FUNC subscription_storage_factory_t adaptive_subscription_storage_factory(std::size_t threshold)
Factory for adaptive subscription storage.
Definition subscr_storage_adaptive.cpp:263
agent_context_t operator+(environment_t &env, Option arg)
A plus operator for creating agent_context object from a reference to Environment and single agent tu...
Definition agent_context.hpp:109
agent_context_t operator+(agent_context_t ctx, message_limit::redirect_indicator_t< M, L > limit)
Definition agent_context.hpp:160
agent_context_t operator+(agent_context_t ctx, message_limit::log_then_abort_app_indicator_t< M, L > limit)
Definition agent_context.hpp:150
agent_context_t operator+(agent_context_t ctx, subscription_storage_factory_t factory)
Definition agent_context.hpp:120
const int rc_attempt_to_cast_to_envelope_on_nullptr
An attempt to cast message to message envelope when a pointer to message is NULL.
Definition ret_code.hpp:351
const int rc_evt_handler_already_provided
A handler for that event/mbox/state is already registered.
Definition ret_code.hpp:105
agent_context_t operator+(agent_context_t ctx, name_for_agent_t agent_name)
Definition agent_context.hpp:197
const int rc_mutable_msg_cannot_be_delivered_via_mpmc_mbox
An attempt to deliver mutable message via MPMC mbox.
Definition ret_code.hpp:234
const int rc_trying_to_add_extra_layer_that_already_exists_in_default_list
The layer is already bound to the SObjectizer Environment as a default layer.
Definition ret_code.hpp:158
@ final_handler
@ intermediate_handler
const int rc_disp_binder_already_set_for_agent
The dispatcher binder is already set for the agent.
Definition ret_code.hpp:492
current_thread_id_t query_current_thread_id()
Get the ID of the current thread.
Definition current_thread_id.hpp:30
const int rc_nullptr_as_delivery_filter_pointer
nullptr can't be passed as delivery_filter.
Definition ret_code.hpp:454
const int rc_message_has_no_limit_defined
An attempt to create subscription to message without predefined limit for that message type.
Definition ret_code.hpp:123
const int rc_negative_value_for_period
An attempt to use negative value for period argument for periodic message/signal.
Definition ret_code.hpp:280
outliving_reference_t< T > outliving_mutable(T &r)
Make outliving_reference wrapper for mutable reference.
Definition outliving.hpp:131
const int rc_mpsc_mbox_expected
An instance of MPSC mbox is expected as custom direct mbox.
Definition ret_code.hpp:443
const int rc_subscription_to_mutable_msg_from_mpmc_mbox
An attempt to make subscription on mutable message from MPMC mbox.
Definition ret_code.hpp:251
const int rc_trying_to_add_nullptr_extra_layer
Unable to bind a layer by the null pointer to it.
Definition ret_code.hpp:155
agent_context_t operator+(agent_context_t ctx, message_limit::transform_indicator_t< M > limit)
Definition agent_context.hpp:170
const int rc_no_disp_binder_for_agent
The dispatcher binder is not set for the agent yet.
Definition ret_code.hpp:505
Type for case when agent has no user-provided name.
Definition agent_identity.hpp:54
SO_5_FUNC std::array< char, c_string_size > make_c_string() const noexcept
Make a c-string with text representation of a value.
Definition agent.cpp:39
static std::unique_ptr< Msg > make()
Definition message.hpp:825
static std::unique_ptr< E > make(Args &&... args)
Definition message.hpp:803
static const constexpr message_mutability_t mutability
Definition message.hpp:414
static const constexpr message_mutability_t mutability
Definition message.hpp:425
Detector of message type traits in dependency of message immutability or mutability.
Definition message.hpp:398
static const constexpr message_mutability_t mutability
Definition message.hpp:403
Description of an event handler.
Definition execution_demand.hpp:220
static void exec(Main_Action main_action, rollbacker_t< Rollback_Action > &rollback)
Definition rollback_on_exception.hpp:62
static Result exec(Main_Action main_action, rollbacker_t< Rollback_Action > &rollback)
Definition rollback_on_exception.hpp:47
const message_limit::control_block_t * m_limit
Optional message limit for that message.
Definition execution_demand.hpp:65
A helper class for temporary setting and then dropping the ID of the current working thread.
Definition agent.hpp:474
so_5::current_thread_id_t & m_id
Definition agent.hpp:475
working_thread_id_sentinel_t(so_5::current_thread_id_t &id_var, so_5::current_thread_id_t value_to_set)
Definition agent.hpp:477
~working_thread_id_sentinel_t()
Definition agent.hpp:485
Information about event_handler and its properties.
Definition subscription_storage_iface.hpp:43
thread_safety_t m_thread_safety
Is event handler thread safe or not.
Definition subscription_storage_iface.hpp:47
Helper for marking initial substate of composite state.
Definition state.hpp:57
A helper class for checking that message is a classical message derived from message_t class.
Definition message.hpp:480
A helper class for checking that message is a mutable message.
Definition message.hpp:496
A helper for detection presence of message of user type.
Definition message.hpp:443
Message limit with reaction 'abort the application'.
Definition message_limit.hpp:164
A control block for one message limit.
Definition message.hpp:976
control_block_t(unsigned int limit, action_t action)
Initializing constructor.
Definition message.hpp:987
static const control_block_t * none()
A special indicator about absence of control_block.
Definition message.hpp:1023
static void decrement(const control_block_t *limit)
Definition message.hpp:1028
A description of one message limit.
Definition message_limit.hpp:47
description_t(std::type_index msg_type, unsigned int limit, action_t action)
Initializing constructor.
Definition message_limit.hpp:58
Message limit with reaction 'drop new message'.
Definition message_limit.hpp:105
static void call(const overlimit_context_t &ctx, L action)
Definition message_limit.hpp:252
Helper class for calling pre-abort action.
Definition message_limit.hpp:232
static void call(const overlimit_context_t &ctx, L action)
Definition message_limit.hpp:234
Helper class for calling pre-abort action.
Definition message_limit.hpp:280
Message limit with reaction 'abort the application' and the possibility to call additional lambda bef...
Definition message_limit.hpp:205
log_then_abort_app_indicator_t(unsigned int limit, L lambda)
Initializing constructor.
Definition message_limit.hpp:213
A mixin with message limit definition methods.
Definition message_limit.hpp:616
static drop_indicator_t< Msg > limit_then_drop(unsigned int limit)
A helper function for creating drop_indicator.
Definition message_limit.hpp:629
static redirect_indicator_t< Msg, Lambda > limit_then_redirect(unsigned int limit, Lambda dest_getter)
A helper function for creating redirect_indicator.
Definition message_limit.hpp:713
static transform_indicator_t< Source > limit_then_transform(unsigned int limit, Lambda &&transformator)
A helper function for creating transform_indicator.
Definition message_limit.hpp:848
static log_then_abort_app_indicator_t< M, L > limit_then_abort(unsigned int limit, L lambda)
A helper function for creating log_then_abort_app_indicator.
Definition message_limit.hpp:670
static abort_app_indicator_t< Msg > limit_then_abort(unsigned int limit)
A helper function for creating abort_app_indicator.
Definition message_limit.hpp:643
static auto limit_then_redirect(unsigned int limit, mbox_t destination)
A helper function for creating redirect_indicator.
Definition message_limit.hpp:747
static transformed_message_t< Msg > make_transformed(mbox_t mbox, Args &&... args)
Helper method for creating message transformation result.
Definition message_limit.hpp:911
static auto limit_then_transform(unsigned int limit, Lambda &&transformator)
A helper function for creating transform_indicator.
Definition message_limit.hpp:790
Description of context for overlimit action.
Definition message.hpp:895
const message_delivery_mode_t m_delivery_mode
Delivery mode for message delivery attempt.
Definition message.hpp:907
overlimit_context_t(mbox_id_t mbox_id, message_delivery_mode_t delivery_mode, const agent_t &receiver, const control_block_t &limit, unsigned int reaction_deep, const std::type_index &msg_type, const message_ref_t &message, const impl::action_msg_tracer_t *msg_tracer)
Initializing constructor.
Definition message.hpp:937
const unsigned int m_reaction_deep
The current deep of overlimit reaction recursion.
Definition message.hpp:916
const message_ref_t & m_message
A message (or enveloped message) to be delivered.
Definition message.hpp:922
const impl::action_msg_tracer_t * m_msg_tracer
An optional pointer to tracer object for message delivery tracing.
Definition message.hpp:933
Indication that a message must be redirected on overlimit.
Definition message_limit.hpp:346
Lambda m_destination_getter
A lambda/functional object which returns mbox for redirection.
Definition message_limit.hpp:351
redirect_indicator_t(unsigned int limit, Lambda destination_getter)
Initializing constructor.
Definition message_limit.hpp:354
An indicator of transform reaction on message overlimit.
Definition message_limit.hpp:542
transform_indicator_t(unsigned int limit, action_t action)
Initializing constructor.
Definition message_limit.hpp:550
static constexpr message_mutability_t mutability()
Helper for getting message mutability flag.
Definition message.hpp:762
static payload_type & payload_reference(message_t &msg)
Helper for getting a const reference to payload part.
Definition message.hpp:753
static payload_type * extract_payload_ptr(message_ref_t &msg)
Helper for extraction of pointer to payload part.
Definition message.hpp:732
static envelope_type * extract_envelope_ptr(message_ref_t &msg)
Helper for extraction of pointer to envelope part.
Definition message.hpp:745
Implementation details for message_payload_type.
Definition message.hpp:626
static constexpr message_mutability_t mutability()
Helper for getting message mutability flag.
Definition message.hpp:684
static payload_type & payload_reference(message_t &msg)
Helper for getting a const reference to payload part.
Definition message.hpp:676
static envelope_type * extract_envelope_ptr(message_ref_t &msg)
Helper for extraction of pointer to envelope part.
Definition message.hpp:668
static payload_type * extract_payload_ptr(message_ref_t &msg)
Helper for extraction of pointer to payload part.
Definition message.hpp:657
A helper class for detection of payload type of message.
Definition message.hpp:783
Helper type with method to be mixed into agent class.
Definition agent_tuning_options.hpp:155
static name_for_agent_t name_for_agent(std::string_view name)
A helper factory for making name_for_agent_t instance.
Definition agent_tuning_options.hpp:175
activation_data_t(timer_id_t timer, steady_clock::time_point expiration_point)
Definition agent.cpp:336
Template class for representing object of user type as a message.
Definition message.hpp:315
kind_t so5_message_kind() const noexcept override
Detect the kind of the message.
Definition message.hpp:346
Generated on Mon Nov 17 2025 22:52:59 for SObjectizer by
1.12.0