so_5::agent_tuning_options_t Class Reference

A collector for agent tuning options. More...

#include <agent_tuning_options.hpp>

Public Member Functions
	agent_tuning_options_t ()=default
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.
const subscription_storage_factory_t &	query_subscription_storage_factory () const noexcept
bool	is_user_provided_subscription_storage_factory () const noexcept
	Does a user provide a specific subscription_storage_factory?
message_limit::description_container_t	giveout_message_limits ()
template<typename... Args>
agent_tuning_options_t &	message_limits (Args &&... args)
agent_tuning_options_t &	priority (so_5::priority_t v)
	Set priority for agent.
so_5::priority_t	query_priority () const noexcept
	Get priority value.
agent_tuning_options_t &	custom_direct_mbox_factory (custom_direct_mbox_factory_t factory)
	Set custom direct mbox factory.
const custom_direct_mbox_factory_t &	query_custom_direct_mbox_factory () const noexcept
	Get a reference to custom direct mbox factory.
agent_tuning_options_t &	agent_name (name_for_agent_t name)
	Set a name for agent.
bool	has_agent_name () const noexcept
	Does a name specified for an agent?
name_for_agent_t	giveout_agent_name () noexcept
	Gives away the name for an agent.

Static Public Member Functions
static subscription_storage_factory_t	default_subscription_storage_factory ()
	Default subscription storage factory.

Private Attributes
subscription_storage_factory_t	m_subscription_storage_factory
message_limit::description_container_t	m_message_limits
so_5::priority_t	m_priority = so_5::prio::default_priority
	Priority for agent.
custom_direct_mbox_factory_t	m_custom_direct_mbox_factory
	Optional factory for custom direct mboxes.
bool	m_is_user_provided_subscription_storage_factory { false }
	Does a user provide a specific subscription_storage_factory?
name_for_agent_t	m_agent_name
	Optional name for an agent.

Friends
void	swap (so_5::agent_tuning_options_t &a, so_5::agent_tuning_options_t &b) noexcept

Detailed Description

A collector for agent tuning options.

Attention

This class isn't thread-safe.

Since

v.5.5.3

Definition at line 196 of file agent_tuning_options.hpp.

Constructor & Destructor Documentation

agent_tuning_options_t()

so_5::agent_tuning_options_t::agent_tuning_options_t ( )

default

Member Function Documentation

agent_name()

agent_tuning_options_t & so_5::agent_tuning_options_t::agent_name ( name_for_agent_t name )

inline

Set a name for agent.

Note

The name should have an actual name, otherwise an exception will be thrown.

Since

v.5.8.2

Definition at line 342 of file agent_tuning_options.hpp.

custom_direct_mbox_factory()

agent_tuning_options_t & so_5::agent_tuning_options_t::custom_direct_mbox_factory ( custom_direct_mbox_factory_t factory )

inline

Set custom direct mbox factory.

Since

v.5.7.4

Definition at line 308 of file agent_tuning_options.hpp.

default_subscription_storage_factory()

static subscription_storage_factory_t so_5::agent_tuning_options_t::default_subscription_storage_factory ( )

inlinestatic

Default subscription storage factory.

Definition at line 260 of file agent_tuning_options.hpp.

giveout_agent_name()

name_for_agent_t so_5::agent_tuning_options_t::giveout_agent_name ( )

inlinenodiscardnoexcept

Gives away the name for an agent.

If the name wasn't set an empty value is returned.

Since

v.5.8.2

Definition at line 374 of file agent_tuning_options.hpp.

giveout_message_limits()

message_limit::description_container_t so_5::agent_tuning_options_t::giveout_message_limits ( )

inlinenodiscard

Definition at line 267 of file agent_tuning_options.hpp.

has_agent_name()

bool so_5::agent_tuning_options_t::has_agent_name ( ) const

inlinenodiscardnoexcept

Does a name specified for an agent?

Since

v.5.8.2

Definition at line 360 of file agent_tuning_options.hpp.

is_user_provided_subscription_storage_factory()

bool so_5::agent_tuning_options_t::is_user_provided_subscription_storage_factory ( ) const

inlinenodiscardnoexcept

Does a user provide a specific subscription_storage_factory?

Return values

false	If subscription_storage_factory wasn't specified by a user.
true	If the subscription_storage_factory was specified by a user.

Since

v.5.8.2

Definition at line 252 of file agent_tuning_options.hpp.

message_limits()

template<typename... Args>

agent_tuning_options_t & so_5::agent_tuning_options_t::message_limits ( Args &&... args )

inline

Definition at line 274 of file agent_tuning_options.hpp.

priority()

agent_tuning_options_t & so_5::agent_tuning_options_t::priority ( so_5::priority_t v )

inline

Set priority for agent.

Since

v.5.5.8

Definition at line 288 of file agent_tuning_options.hpp.

query_custom_direct_mbox_factory()

const custom_direct_mbox_factory_t & so_5::agent_tuning_options_t::query_custom_direct_mbox_factory ( ) const

inlinenodiscardnoexcept

Get a reference to custom direct mbox factory.

Note

If the factory isn't set then a reference to empty std::function object is returned.

Since

v.5.7.4

Definition at line 327 of file agent_tuning_options.hpp.

query_priority()

so_5::priority_t so_5::agent_tuning_options_t::query_priority ( ) const

inlinenodiscardnoexcept

Get priority value.

Definition at line 297 of file agent_tuning_options.hpp.

query_subscription_storage_factory()

const subscription_storage_factory_t & so_5::agent_tuning_options_t::query_subscription_storage_factory ( ) const

inlinenodiscardnoexcept

Definition at line 237 of file agent_tuning_options.hpp.

subscription_storage_factory()

agent_tuning_options_t & so_5::agent_tuning_options_t::subscription_storage_factory ( subscription_storage_factory_t factory )

inlinenoexcept

Set factory for subscription storage creation.

Definition at line 220 of file agent_tuning_options.hpp.

Friends And Related Symbol Documentation

swap

void swap ( so_5::agent_tuning_options_t & a, so_5::agent_tuning_options_t & b )

friend

Definition at line 202 of file agent_tuning_options.hpp.

Member Data Documentation

m_agent_name

name_for_agent_t so_5::agent_tuning_options_t::m_agent_name

private

Optional name for an agent.

Since

v.5.8.2

Definition at line 419 of file agent_tuning_options.hpp.

m_custom_direct_mbox_factory

custom_direct_mbox_factory_t so_5::agent_tuning_options_t::m_custom_direct_mbox_factory

private

Optional factory for custom direct mboxes.

It can be an empty std::function object.

Since

v.5.7.4

Definition at line 402 of file agent_tuning_options.hpp.

m_is_user_provided_subscription_storage_factory

bool so_5::agent_tuning_options_t::m_is_user_provided_subscription_storage_factory { false }

private

Does a user provide a specific subscription_storage_factory?

This member is set to true in subscription_storage_factory() setter.

Since

v.5.8.2

Definition at line 412 of file agent_tuning_options.hpp.

m_message_limits

message_limit::description_container_t so_5::agent_tuning_options_t::m_message_limits

private

Definition at line 387 of file agent_tuning_options.hpp.

m_priority

so_5::priority_t so_5::agent_tuning_options_t::m_priority = so_5::prio::default_priority

private

Priority for agent.

Since

v.5.5.8

Definition at line 393 of file agent_tuning_options.hpp.

m_subscription_storage_factory

subscription_storage_factory_t so_5::agent_tuning_options_t::m_subscription_storage_factory

private

Initial value:

=
        default_subscription_storage_factory()

Definition at line 384 of file agent_tuning_options.hpp.

---

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

• agent_tuning_options.hpp