Пространство имен so_5::api

API для запуска SObjectizer. Подробнее...

Классы
class	env_init_caller_base_t
	Базовый класс для вызова инициализирующей функции SObjectizer. Подробнее...
class	env_init_with_param_caller_t
	Вызыватель функции инициализации SObjectizer с параметром. Подробнее...
class	env_init_as_method_caller_t
	Вызыватель функции инициализации SObjectizer как метод класса. Подробнее...

Определения типов
typedef void(SO_5_MODULE_CALLING_CONVENTION *	pfn_so_environment_init_t )(so_5::rt::so_environment_t &)
	Псевдоним для простой функции инициализации SObjectizer.

Функции
	run_so_environment (pfn_so_environment_init_t init_func,const so_5::rt::so_environment_params_t &env_params,throwing_strategy_t throwing_strategy=THROW_ON_ERROR)
	Запустить среду SO с параметрами. Подробнее...
	run_so_environment (pfn_so_environment_init_t init_func,throwing_strategy_t throwing_strategy=THROW_ON_ERROR)
	Запустить среду SO с параметрами по умолчанию. Подробнее...
	run_so_environment (env_init_caller_base_t &init_caller, throwing_strategy_t throwing_strategy)
	Запустить среду SO с параметрами по умолчанию. Подробнее...
	run_so_environment (env_init_caller_base_t &init_caller, const so_5::rt::so_environment_params_t &env_params, throwing_strategy_t throwing_strategy)
	Запустить среду SO с параметрами. Подробнее...
template<class PARAM_TYPE >
so_5::ret_code_t	run_so_environment_with_parameter (typename env_init_with_param_caller_t< PARAM_TYPE >::INIT_FUNC_T init_func, const PARAM_TYPE &param, throwing_strategy_t throwing_strategy=THROW_ON_ERROR)
	Запустить SObjectizer c параметризованной функцией. Подробнее...
template<class PARAM_TYPE >
so_5::ret_code_t	run_so_environment_with_parameter (typename env_init_with_param_caller_t< PARAM_TYPE >::INIT_FUNC_T init_func, const PARAM_TYPE &param, const so_5::rt::so_environment_params_t &env_params, throwing_strategy_t throwing_strategy=THROW_ON_ERROR)
	Запустить SObjectizer c параметризованной функцией с заданными параметрами. Подробнее...
template<class OBJECT >
so_5::ret_code_t	run_so_environment_on_object (OBJECT &obj, typename env_init_as_method_caller_t< OBJECT >::INIT_METHOD_T init_func, throwing_strategy_t throwing_strategy=THROW_ON_ERROR)
	Запустить SObjectizer c функцией-методом класса. Подробнее...
template<class OBJECT >
so_5::ret_code_t	run_so_environment_on_object (OBJECT &obj, typename env_init_as_method_caller_t< OBJECT >::INIT_METHOD_T init_func, const so_5::rt::so_environment_params_t &env_params, throwing_strategy_t throwing_strategy=THROW_ON_ERROR)
	Запустить SObjectizer c функцией-методом класса с заданными параметрами. Подробнее...

Подробное описание

API для запуска SObjectizer.

Функции

so_5::api::run_so_environment	(	pfn_so_environment_init_t	init_func,
		const so_5::rt::so_environment_params_t &	env_params,
		throwing_strategy_t	throwing_strategy = THROW_ON_ERROR
	)

Запустить среду SO с параметрами.

Пример:

void
init( so_5::rt::so_environment_t & env )
{
  auto coop = env.create_coop( "main_coop" );
  coop->add_agent(
    so_5::rt::agent_ref_t(
      new a_main_t ) );

  env.register_coop( std::move( coop ) );
}

...

int
main( int argc, char * argv[] )
{
  return so_5::api::run_so_environment(
    &init,
    so_5::rt::so_environment_params_t()
      .mbox_mutex_pool_size( 16 )
      .agent_coop_mutex_pool_size( 16 )
      .agent_event_queue_mutex_pool_size( 16 ),
    so_5::DO_NOT_THROW_ON_ERROR );
}

Аргументы

init_func	Указатель на функцию, которая выполняет инициализацию.
env_params	Параметры среды.
throwing_strategy	Флаг - бросать ли исключение в случае ошибок.

Примеры:

mbapi_4/binary_messages, so_5/chstate, so_5/coop_listener, so_5/disp, so_5/exception_handler, so_5/exception_logger, so_5/hello_all, so_5/hello_delay, so_5/hello_evt_handler, so_5/hello_periodic, so_5/hello_world и so_5/layer.

Используется в run_so_environment(), run_so_environment_on_object() и run_so_environment_with_parameter().

so_5::api::run_so_environment	(	pfn_so_environment_init_t	init_func,
		throwing_strategy_t	throwing_strategy = THROW_ON_ERROR
	)

Запустить среду SO с параметрами по умолчанию.

Пример:

void
init( so_5::rt::so_environment_t & env )
{
  auto coop = env.create_coop( "main_coop" );
  coop->add_agent(
    so_5::rt::agent_ref_t(
      new a_main_t ) );

  env.register_coop( std::move( coop ) );
}

...

int
main( int argc, char * argv[] )
{
  try
  {
    so_5::api::run_so_environment( &init );
  }
  catch( const std::exception & ex )
  {
    std::cerr << "Error: " << ex.what() << std::endl;
    return 1;
  }

  return 0;
}

Аргументы

init_func	Указатель на функцию, которая выполняет инициализацию.
throwing_strategy	Флаг - бросать ли исключение в случае ошибок.

Перекрестные ссылки run_so_environment().

so_5::api::run_so_environment	(	env_init_caller_base_t &	init_caller,
		throwing_strategy_t	throwing_strategy
	)

Запустить среду SO с параметрами по умолчанию.

Инициализирует SObjectizer через env_init_caller_base_t. Используется для работы run_so_environment_with_parameter() и run_so_environment_on_object().

Перекрестные ссылки run_so_environment().

so_5::api::run_so_environment	(	env_init_caller_base_t &	init_caller,
		const so_5::rt::so_environment_params_t &	env_params,
		throwing_strategy_t	throwing_strategy
	)

Запустить среду SO с параметрами.

Инициализирует SObjectizer через env_init_caller_base_t.

template<class OBJECT >

so_5::ret_code_t so_5::api::run_so_environment_on_object	(	OBJECT &	obj,
		typename env_init_as_method_caller_t< OBJECT >::INIT_METHOD_T	init_func,
		throwing_strategy_t	throwing_strategy = THROW_ON_ERROR
	)

Запустить SObjectizer c функцией-методом класса.

Аргументы

obj	Объект инициализатор.
init_func	Метод инициализации.
throwing_strategy	Флаг - бросать ли исключение в случае ошибок.

Примеры:

mbapi_4/ping, mbapi_4/stages и so_5_transport/raw_channel/tcp_cln.

Перекрестные ссылки run_so_environment().

template<class OBJECT >

so_5::ret_code_t so_5::api::run_so_environment_on_object	(	OBJECT &	obj,
		typename env_init_as_method_caller_t< OBJECT >::INIT_METHOD_T	init_func,
		const so_5::rt::so_environment_params_t &	env_params,
		throwing_strategy_t	throwing_strategy = THROW_ON_ERROR
	)

Запустить SObjectizer c функцией-методом класса с заданными параметрами.

Аргументы

obj	Объект инициализатор.
init_func	Метод инициализации.
env_params	Параметры SObjectizer.
throwing_strategy	Флаг - бросать ли исключение в случае ошибок.

Перекрестные ссылки run_so_environment().

template<class PARAM_TYPE >

so_5::ret_code_t so_5::api::run_so_environment_with_parameter	(	typename env_init_with_param_caller_t< PARAM_TYPE >::INIT_FUNC_T	init_func,
		const PARAM_TYPE &	param,
		throwing_strategy_t	throwing_strategy = THROW_ON_ERROR
	)

Запустить SObjectizer c параметризованной функцией.

Аргументы

init_func	Инициализирующая функция с параметром. Функция должна иметь вид: void init( env, my_param ).
param	Дополнительный параметр.
throwing_strategy	Флаг - бросать ли исключение в случае ошибок.

Примеры:

so_5_transport/raw_channe/tcp_srv.

Перекрестные ссылки run_so_environment().

Используется в so_sysconf_4::process::run_sobjectizer() и so_sysconf_4::daemon::run_sobjectizer().

template<class PARAM_TYPE >

so_5::ret_code_t so_5::api::run_so_environment_with_parameter	(	typename env_init_with_param_caller_t< PARAM_TYPE >::INIT_FUNC_T	init_func,
		const PARAM_TYPE &	param,
		const so_5::rt::so_environment_params_t &	env_params,
		throwing_strategy_t	throwing_strategy = THROW_ON_ERROR
	)

Запустить SObjectizer c параметризованной функцией с заданными параметрами.

Аргументы

init_func	Инициализирующая функция с параметром. Функция должна иметь вид: void init( env, my_param ).
param	Дополнительный параметр.
env_params	Параметры SObjectizer.
throwing_strategy	Флаг - бросать ли исключение в случае ошибок.

Перекрестные ссылки run_so_environment().