api.hpp File Reference

Function for the SObjectizer starting. More...

#include <functional>
#include <so_5/h/declspec.hpp>
#include <so_5/h/compiler_features.hpp>
#include <so_5/rt/h/environment.hpp>

Go to the source code of this file.

Classes
class	so_5::api::impl::so_quick_environment_t< Init >
	Auxiliary class for the SObjectizer launching. More...

Namespaces
	so_5
	Public part of message limit implementation.
	so_5::api
	Public API functions of SObjectizer-5.
	so_5::api::impl
	Internal implemetation details of public API functions.

Typedefs
typedef void(*	so_5::api::pfn_so_environment_init_t) (so_5::environment_t &)
	Typedef for a simple SObjectizer-initialization function. More...
typedef std::function< void(so_5::environment_t &) >	so_5::api::generic_simple_init_t
	Generic type for a simple SObjectizer-initialization function. More...
typedef std::function< void(so_5::environment_params_t &) >	so_5::api::generic_simple_so_env_params_tuner_t
	Generic type for a simple SO Environment paramenters tuning function. More...

Functions
void	so_5::api::run_so_environment (generic_simple_init_t init_routine, so_5::environment_params_t &&env_params)
	Launch a SObjectizer Environment with arguments. More...
void	so_5::api::run_so_environment (generic_simple_init_t init_routine)
	Launch a SObjectizer Environment with default arguments. More...
void	so_5::api::run_so_environment (generic_simple_init_t init_routine, generic_simple_so_env_params_tuner_t params_tuner)
	Launch a SObjectizer Environment with arguments. More...
template<class Init , class Param_Type >
void	so_5::api::run_so_environment_with_parameter (Init init_func, const Param_Type &param, so_5::environment_params_t &&env_params)
template<class Init , class Param_Type >
void	so_5::api::run_so_environment_with_parameter (Init init_func, const Param_Type &param)
template<class Object , class Method >
void	so_5::api::run_so_environment_on_object (Object &obj, Method init_func, so_5::environment_params_t &&env_params)
template<class Object , class Method >
void	so_5::api::run_so_environment_on_object (Object &obj, Method init_func)
	Launch a SObjectizer Environment by a class method. More...
void	so_5::launch (so_5::api::generic_simple_init_t init_routine)
	Launch a SObjectizer Environment with default parameters. More...
void	so_5::launch (so_5::api::generic_simple_init_t init_routine, so_5::api::generic_simple_so_env_params_tuner_t params_tuner)
	Launch a SObjectizer Environment with explicitely specified parameters. More...

Detailed Description

Function for the SObjectizer starting.

It is not necessary to derive a class from the so_5::environment_t to start a SObjectizer Environment. SObjectizer contains several functions which make a SObjectizer Environment launching process easier.

This file contains declarations of these functions.