SObjectizer  5.8
Loading...
Searching...
No Matches
std_names.hpp
Go to the documentation of this file.
1/*
2 * SObjectizer-5
3 */
4
5/*!
6 * \since
7 * v.5.5.4
8 *
9 * \file
10 * \brief Standard data sources prefixes and suffixes used by SObjectizer.
11 */
12
13#pragma once
14
15#include <so_5/stats/prefix.hpp>
16
17#include <so_5/declspec.hpp>
18
19namespace so_5 {
20
21namespace stats {
22
23namespace prefixes {
24
25/*!
26 * \since
27 * v.5.5.4
28 *
29 * \brief Prefix of data sources with statistics for cooperations and
30 * agents repository.
31 */
34
35/*!
36 * \since
37 * v.5.5.4
38 *
39 * \brief Prefix of data sources with statistics for mboxes repository.
40 */
43
44/*!
45 * \since
46 * v.5.5.4
47 *
48 * \brief Prefix of data sources with statistics for timer thread.
49 */
52
53} /* namespace prefixes */
54
55namespace suffixes {
56
57/*!
58 * \since
59 * v.5.6.0
60 *
61 * \brief Suffix for data source with count of cooperations.
62 */
65
66/*!
67 * \since
68 * v.5.5.12
69 *
70 * \brief Suffix for data source with count of cooperations waiting
71 * the final deregistration step and removement from coops registry.
72 */
75
76/*!
77 * \since
78 * v.5.5.4
79 *
80 * \brief Suffix for data source with count of named mboxes.
81 */
84
85/*!
86 * \since
87 * v.5.5.4
88 *
89 * \brief Suffix for data source with count of agents bound to some entity.
90 */
93
94/*!
95 * \since
96 * v.5.5.4
97 *
98 * \brief Suffix for data source with count of active groups in
99 * an active_group dispatcher.
100 */
103
104/*!
105 * \since
106 * v.5.5.4
107 *
108 * \brief Suffix for data source with count of demands in a working thread event queue.
109 */
112
113/*!
114 * \since
115 * v.5.5.18
116 *
117 * \brief Suffix for data source with work thread activity statistics.
118 */
121
122/*!
123 * \since
124 * v.5.5.4
125 *
126 * \brief Suffix for data source with count of work threads for dispatcher.
127 */
130
131/*!
132 * \since
133 * v.5.5.4
134 *
135 * \brief Suffix for data source with count of single-shot timers.
136 */
139
140/*!
141 * \since
142 * v.5.5.4
143 *
144 * \brief Suffix for data source with count of periodic timers.
145 */
148
149/*!
150 * \since
151 * v.5.5.8
152 *
153 * \brief Suffix for data source with size of quote for demands processing.
154 *
155 * This suffix is used in prio_one_thread::quoted_round_robin dispatcher.
156 */
159
160} /* namespace suffixes */
161
162} /* namespace stats */
163
164} /* namespace so_5 */
A base class for agents.
Definition agent.hpp:673
Alias for namespace with traits of event queue.
const queue_traits::queue_params_t & queue_params() const
Getter for queue parameters.
disp_params_t & tune_queue_params(L tunner)
Tuner for queue parameters.
queue_traits::queue_params_t m_queue_params
Queue parameters.
friend void swap(disp_params_t &a, disp_params_t &b) noexcept
disp_params_t & set_queue_params(queue_traits::queue_params_t p)
Setter for queue parameters.
disp_params_t()=default
Default constructor.
A handle for active_group dispatcher.
dispatcher_handle_t(impl::basic_dispatcher_iface_shptr_t dispatcher) noexcept
impl::basic_dispatcher_iface_shptr_t m_dispatcher
A reference to actual implementation of a dispatcher.
bool empty() const noexcept
Is this handle empty?
void reset() noexcept
Drop the content of handle.
bool operator!() const noexcept
Does this handle contain a reference to dispatcher?
operator bool() const noexcept
Is this handle empty?
disp_binder_shptr_t binder(nonempty_name_t group_name) const
Get a binder for that dispatcher.
const std::string m_group_name
Name of group for new agents.
void preallocate_resources(agent_t &) override
Allocate resources in dispatcher for new agent.
void unbind(agent_t &) noexcept override
Unbind agent from dispatcher.
void bind(agent_t &agent) noexcept override
Bind agent to dispatcher.
actual_dispatcher_iface_shptr_t m_disp
Dispatcher to be used.
void undo_preallocation(agent_t &) noexcept override
Undo resources allocation.
actual_binder_t(actual_dispatcher_iface_shptr_t disp, nonempty_name_t group_name) noexcept
An actual interface of active group dispatcher.
virtual so_5::event_queue_t * query_thread_for_group(const std::string &group_name) noexcept=0
Get the event_queue for the specified active group.
virtual void release_thread_for_group(const std::string &group_name) noexcept=0
Release the thread for the specified active group.
virtual void allocate_thread_for_group(const std::string &group_name)=0
Create a new thread for a group if it necessary.
The very basic interface of active_group dispatcher.
virtual disp_binder_shptr_t binder(nonempty_name_t group_name)=0
static dispatcher_handle_t make(actual_dispatcher_iface_shptr_t disp) noexcept
outliving_reference_t< dispatcher_template_t > m_dispatcher
Dispatcher to work with.
void distribute_value_for_work_thread(const so_5::mbox_t &mbox, const std::string &group_name, const thread_with_refcounter_t &wt)
disp_data_source_t(const std::string_view name_base, outliving_reference_t< dispatcher_template_t > disp)
void distribute(const so_5::mbox_t &mbox) override
Send appropriate notification about the current value.
void release_thread_for_group(const std::string &group_name) noexcept override
Release the thread for the specified active group.
void allocate_thread_for_group(const std::string &group_name) override
Create a new thread for a group if it necessary.
outliving_reference_t< environment_t > m_env
SObjectizer Environment to work in.
so_5::event_queue_t * query_thread_for_group(const std::string &group_name) noexcept override
Get the event_queue for the specified active group.
active_group_map_t m_groups
A map of dispatchers for active groups.
const disp_params_t m_params
Parameters for the dispatcher.
dispatcher_template_t(outliving_reference_t< environment_t > env, const std::string_view name_base, disp_params_t params)
work_thread_shptr_t search_and_try_remove_group_from_map(const std::string &group_name) noexcept
Helper function for searching and erasing agent's thread from map of active threads.
stats::auto_registered_source_holder_t< disp_data_source_t > m_data_source
Data source for run-time monitoring.
disp_binder_shptr_t binder(nonempty_name_t group_name) override
Container for storing parameters for MPSC queue.
A part of demand queue implementation for the case when activity tracking is not used.
std::size_t demands_count(const demands_counter_t &external_counter)
Get the count of demands in the queue.
virtual void push(execution_demand_t demand) override
Enqueue new event to the queue.
extraction_result_t pop(demand_container_t &demands, demands_counter_t &external_counter)
Try to extract demands from the queue.
A part of demand queue implementation for the case when activity tracking is used.
so_5::stats::activity_tracking_stuff::stats_collector_t< so_5::stats::activity_tracking_stuff::external_lock< queue_traits::lock_t, so_5::stats::activity_tracking_stuff::no_lock_at_start_stop_policy > > m_waiting_stats
Part of implementation of work thread with activity tracking.
so_5::stats::work_thread_activity_stats_t take_activity_stats()
Get the activity stats.
const so_5::stats::clock_type_t::time_point * m_activity_started_at
Pointer to time_point object related to the current activity.
activity_tracking_impl_t(work_thread_holder_t thread_holder, queue_traits::lock_factory_t queue_lock_factory)
activity_tracking_traits::lock_t m_stats_lock
Lock for manipulation of activity stats.
void serve_demands_block(demand_container_t &demands)
Main method for serving block of demands.
Part of implementation of work thread without activity tracking.
void serve_demands_block(demand_container_t &demands)
Main method for serving block of demands.
no_activity_tracking_impl_t(work_thread_holder_t thread_holder, queue_traits::lock_factory_t queue_lock_factory)
event_queue_t & event_queue()
Get the underlying event_queue object.
work_thread_template_t(work_thread_holder_t thread_holder, queue_traits::lock_factory_t queue_lock_factory)
event_queue_t * get_agent_binding()
Get a binding information for an agent.
so_5::current_thread_id_t thread_id() const
Get ID of work thread.
Mixin that holds optional work thread factory.
An analog of unique_ptr for abstract_work_thread.
Interface for dispatcher binders.
SObjectizer Environment.
An interface of event queue for agent.
A base class for agent messages.
Definition message.hpp:47
A class for the name which cannot be empty.
Helper class for indication of long-lived reference via its type.
Definition outliving.hpp:98
Base for the case of externals stats lock.
Base for the case of internal stats lock.
so_5::stats::activity_stats_t m_work_activity
A statistics for work activity.
void start_if_not_started()
A helper method for safe start if start method hasn't been called yet.
so_5::stats::clock_type_t::time_point m_work_started_at
A time point when current activity started.
bool m_is_in_working
A flag for indicating work activity.
A holder for data-souce that should be automatically registered and deregistered in registry.
A type for storing prefix of data_source name.
Definition prefix.hpp:32
bool operator<(const prefix_t &o) const noexcept
Is less than?
Definition prefix.hpp:123
constexpr prefix_t() noexcept
Default constructor creates empty prefix.
Definition prefix.hpp:40
constexpr bool empty() const noexcept
Is prefix empty?
Definition prefix.hpp:99
static constexpr const std::size_t max_buffer_size
Max size of buffer for prefix value (including 0-symbol at the end).
Definition prefix.hpp:37
constexpr std::string_view as_string_view() const noexcept(noexcept(std::string_view{std::declval< const char * >()}))
Access to prefix value as string_view.
Definition prefix.hpp:91
constexpr const char * c_str() const noexcept
Access to prefix value.
Definition prefix.hpp:80
constexpr prefix_t(const char *value) noexcept
Initializing constructor.
Definition prefix.hpp:54
bool operator!=(const prefix_t &o) const noexcept
Is not equal?
Definition prefix.hpp:115
static constexpr const std::size_t max_length
Max length of prefix (not including 0-symbol at the end).
Definition prefix.hpp:35
char m_value[max_buffer_size]
Actual value.
Definition prefix.hpp:130
prefix_t(const std::string &value) noexcept(noexcept(value.c_str()))
Initializing constructor.
Definition prefix.hpp:73
bool operator==(const prefix_t &o) const noexcept
Is equal?
Definition prefix.hpp:107
An interface of data source.
A type for representing the suffix of data_source name.
Definition prefix.hpp:156
constexpr bool operator<(const suffix_t &o) const noexcept
Compares suffixes by pointer value.
Definition prefix.hpp:203
constexpr bool operator==(const suffix_t &o) const noexcept
Compares suffixes by pointer values.
Definition prefix.hpp:187
constexpr const char * c_str() const noexcept
Access to suffix value.
Definition prefix.hpp:168
const char * m_value
Actual value.
Definition prefix.hpp:210
constexpr std::string_view as_string_view() const noexcept(noexcept(std::string_view{std::declval< const char * >()}))
Access to prefix value as string_view.
Definition prefix.hpp:179
constexpr suffix_t(const char *value) noexcept
Initializing constructor.
Definition prefix.hpp:159
constexpr bool operator!=(const suffix_t &o) const noexcept
Compares suffixes by pointer value.
Definition prefix.hpp:195
#define SO_5_TYPE
Definition declspec.hpp:46
#define SO_5_FUNC
Definition declspec.hpp:48
#define SO_5_THROW_EXCEPTION(error_code, desc)
Definition exception.hpp:74
#define SO_5_EXPORT_IMPORT_FOR_QUANTITY_MSG
Definition messages.hpp:45
Helpers for manipulation with standard C++ I/O streams.
Some reusable and low-level classes/functions which can be used in public header files.
void shutdown_and_wait(T &w)
Just a helper function for consequetive call to shutdown and wait.
void send_thread_activity_stats(const so_5::mbox_t &, const stats::prefix_t &, work_thread::work_thread_no_activity_tracking_t &)
void send_thread_activity_stats(const so_5::mbox_t &mbox, const stats::prefix_t &prefix, work_thread::work_thread_with_activity_tracking_t &wt)
Active groups dispatcher implemetation details.
Active groups dispatcher.
dispatcher_handle_t make_dispatcher(so_5::environment_t &env, const std::string_view data_sources_name_base)
Create an instance of active_group dispatcher.
dispatcher_handle_t make_dispatcher(so_5::environment_t &env)
Create an instance of active_group dispatcher.
SO_5_FUNC dispatcher_handle_t make_dispatcher(environment_t &env, const std::string_view data_sources_name_base, disp_params_t params)
Create an instance of active_group dispatcher.
Various stuff related to MPSC event queue implementation and tuning.
@ working
1 - thread execution should be continued.
@ stopped
0 - thread execution should be stopped.
Implemetation details of dispatcher's working thread.
extraction_result_t
Type for result of demand extraction.
@ shutting_down
Demand has not been extracted because of shutdown.
@ no_demands
Demand has not been extracted because the demand queue is empty.
Reusable components for dispatchers.
abstract_work_thread_factory_shptr_t actual_work_thread_factory_to_use(const work_thread_factory_mixin_t< Params > &params, const environment_t &env) noexcept
Helper to detect actual work thread factory to be used.
work_thread_holder_t acquire_work_thread(const work_thread_factory_mixin_t< Params > &params, environment_t &env)
Helper function for acquiring a new worker thread from an appropriate work thread factory.
so_5::stats::prefix_t make_disp_prefix(const std::string_view disp_type, const std::string_view data_sources_name_base, const void *disp_this_pointer)
Create basic prefix for dispatcher data source names.
void modify_disp_params(so_5::environment_t &env, Disp_Params_Type &params)
Helper functions to adjust some dispatcher parameters with respect to settings from environment.
so_5::stats::prefix_t make_disp_working_thread_prefix(const so_5::stats::prefix_t &disp_prefix, std::size_t thread_number)
Create prefix for dispatcher's working thread data source.
std::unique_ptr< Disp_Iface_Type > make_actual_dispatcher(outliving_reference_t< environment_t > env, const std::string_view name_base, Disp_Params_Type disp_params, Args &&...args)
Helper function for creation of dispatcher instance with respect to work thread activity tracking fla...
Event dispatchers.
Details of SObjectizer run-time implementations.
Definition agent.cpp:905
void ensure_join_from_different_thread(current_thread_id_t thread_to_be_joined)
Ensures that join will be called from different thread.
std::unique_ptr< Common_Disp_Iface_Type > create_appropriate_disp(outliving_reference_t< Env > env, const std::string_view name_base, Disp_Params disp_params, Args &&...args)
Helper function for creation of dispatcher with respect to activity tracking flag in dispatcher param...
void update_stats_from_current_time(activity_stats_t &value_to_update, clock_type_t::time_point activity_started_at)
Helper function for simplification of current stats update.
void update_stats_from_duration(activity_stats_t &value_to_update, clock_type_t::duration last_duration)
Helper function for simplification of current stats update.
duration_t calc_avg_time(std::uint_fast64_t count, duration_t previous, duration_t last)
A function for calculating average value.
Declarations of messages used by run-time monitoring and statistics.
Definition messages.hpp:36
Predefined prefixes of data-sources.
Definition std_names.hpp:23
SO_5_FUNC prefix_t coop_repository()
Prefix of data sources with statistics for cooperations and agents repository.
Definition std_names.cpp:22
SO_5_FUNC prefix_t timer_thread()
Prefix of data sources with statistics for timer thread.
Definition std_names.cpp:34
SO_5_FUNC prefix_t mbox_repository()
Prefix of data sources with statistics for mboxes repository.
Definition std_names.cpp:28
Predefined suffixes of data-sources.
Definition std_names.hpp:55
SO_5_FUNC suffix_t coop_final_dereg_count()
Suffix for data source with count of cooperations waiting the final deregistration step and removemen...
Definition std_names.cpp:54
SO_5_FUNC suffix_t agent_count()
Suffix for data source with count of agents bound to some entity.
Definition std_names.cpp:66
SO_5_FUNC suffix_t work_thread_queue_size()
Suffix for data source with count of demands in a working thread event queue.
Definition std_names.cpp:78
SO_5_FUNC suffix_t named_mbox_count()
Suffix for data source with count of named mboxes.
Definition std_names.cpp:60
SO_5_FUNC suffix_t disp_active_group_count()
Suffix for data source with count of active groups in an active_group dispatcher.
Definition std_names.cpp:72
SO_5_FUNC suffix_t work_thread_activity()
Suffix for data source with work thread activity statistics.
Definition std_names.cpp:84
SO_5_FUNC suffix_t disp_thread_count()
Suffix for data source with count of work threads for dispatcher.
Definition std_names.cpp:90
SO_5_FUNC suffix_t timer_periodic_count()
Suffix for data source with count of periodic timers.
SO_5_FUNC suffix_t coop_count()
Suffix for data source with count of cooperations.
Definition std_names.cpp:48
SO_5_FUNC suffix_t timer_single_shot_count()
Suffix for data source with count of single-shot timers.
Definition std_names.cpp:96
SO_5_FUNC suffix_t demand_quote()
Suffix for data source with size of quote for demands processing.
All stuff related to run-time monitoring and statistics.
std::ostream & operator<<(std::ostream &to, const prefix_t &what)
Just a helper operator.
Definition prefix.hpp:139
std::ostream & operator<<(std::ostream &to, const suffix_t &what)
Just a helper operator.
Definition prefix.hpp:219
std::ostream & operator<<(std::ostream &to, const activity_stats_t &what)
Helper for printing value of activity_stats.
Private part of message limit implementation.
Definition agent.cpp:33
common_data_t(queue_traits::lock_unique_ptr_t lock)
Initializing constructor.
common_data_t(work_thread_holder_t thread_holder, queue_traits::lock_factory_t queue_lock_factory)
demands_counter_t m_demands_count
A counter for calculating count of demands in the queue.
A description of event execution demand.
Statistics of some activity.
std::optional< duration_t > m_current_activity_time
duration_t m_avg_time
Average time for one event.
duration_t m_total_time
Total time spent for events in that period of time.
std::uint_fast64_t m_count
Count of events in that period of time.
Default locking policy for stats_collector_t.
An analog of std::lock_guard but without actual locking actions.
A special class for cases where lock is not needed at all.
Various traits of activity tracking implementation.
Notification about finish of stats distribution.
Definition messages.hpp:100
Notification about start of new stats distribution.
Definition messages.hpp:90
A message with value of some quantity.
Definition messages.hpp:60
suffix_t m_suffix
Suffix of data_source name.
Definition messages.hpp:64
T m_value
Actual quantity value.
Definition messages.hpp:67
prefix_t m_prefix
Prefix of data_source name.
Definition messages.hpp:62
quantity(const prefix_t &prefix, const suffix_t &suffix, T value)
Initializing constructor.
Definition messages.hpp:70
Information about one work thread activity.
Definition messages.hpp:108
work_thread_activity_stats_t m_stats
Actual value.
Definition messages.hpp:118
work_thread_activity(const prefix_t &prefix, const suffix_t &suffix, const so_5::current_thread_id_t &thread_id, work_thread_activity_stats_t stats)
Definition messages.hpp:120
prefix_t m_prefix
Prefix of data_source name.
Definition messages.hpp:110
suffix_t m_suffix
Suffix of data_source name.
Definition messages.hpp:112
so_5::current_thread_id_t m_thread_id
ID of the thread.
Definition messages.hpp:115
activity_stats_t m_working_stats
Stats for processed events.
activity_stats_t m_waiting_stats
Stats for waiting periods.