| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196 |
- //
- // config.hpp
- // ~~~~~~~~~~
- //
- // Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com)
- //
- // Distributed under the Boost Software License, Version 1.0. (See accompanying
- // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
- //
- #ifndef BOOST_ASIO_CONFIG_HPP
- #define BOOST_ASIO_CONFIG_HPP
- #if defined(_MSC_VER) && (_MSC_VER >= 1200)
- # pragma once
- #endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
- #include <boost/asio/detail/config.hpp>
- #include <boost/asio/detail/throw_exception.hpp>
- #include <boost/asio/detail/type_traits.hpp>
- #include <boost/asio/execution_context.hpp>
- #include <cstddef>
- #include <string>
- #include <boost/asio/detail/push_options.hpp>
- namespace boost {
- namespace asio {
- /// Base class for configuration implementations.
- class config_service :
- #if defined(GENERATING_DOCUMENTATION)
- public execution_context::service
- #else // defined(GENERATING_DOCUMENTATION)
- public detail::execution_context_service_base<config_service>
- #endif // defined(GENERATING_DOCUMENTATION)
- {
- public:
- #if defined(GENERATING_DOCUMENTATION)
- typedef config_service key_type;
- #endif // defined(GENERATING_DOCUMENTATION)
- /// Constructor.
- BOOST_ASIO_DECL explicit config_service(execution_context& ctx);
- /// Shutdown the service.
- BOOST_ASIO_DECL void shutdown() override;
- /// Retrieve a configuration value.
- BOOST_ASIO_DECL virtual const char* get_value(const char* section,
- const char* key_name, char* value, std::size_t value_len) const;
- };
- /// Provides access to the configuration values associated with an execution
- /// context.
- class config
- {
- public:
- /// Constructor.
- /**
- * This constructor initialises a @c config object to retrieve configuration
- * values associated with the specified execution context.
- */
- explicit config(execution_context& context)
- : service_(use_service<config_service>(context))
- {
- }
- /// Copy constructor.
- config(const config& other) noexcept
- : service_(other.service_)
- {
- }
- /// Retrieve an integral configuration value.
- template <typename T>
- constraint_t<is_integral<T>::value, T>
- get(const char* section, const char* key_name, T default_value) const;
- private:
- config_service& service_;
- };
- /// Configures an execution context based on a concurrency hint.
- /**
- * This configuration service is provided for backwards compatibility with
- * the existing concurrency hint mechanism.
- *
- * @par Example
- * @code boost::asio::io_context my_io_context{
- * boost::asio::config_from_concurrency_hint{1}}; @endcode
- */
- class config_from_concurrency_hint : public execution_context::service_maker
- {
- public:
- /// Construct with a default concurrency hint.
- BOOST_ASIO_DECL config_from_concurrency_hint();
- /// Construct with a specified concurrency hint.
- explicit config_from_concurrency_hint(int concurrency_hint)
- : concurrency_hint_(concurrency_hint)
- {
- }
- /// Add a concrete service to the specified execution context.
- BOOST_ASIO_DECL void make(execution_context& ctx) const override;
- private:
- int concurrency_hint_;
- };
- /// Configures an execution context by reading variables from a string.
- /**
- * Each variable must be on a line of its own, and of the form:
- *
- * <tt>section.key=value</tt>
- *
- * or, if an optional prefix is specified:
- *
- * <tt>prefix.section.key=value</tt>
- *
- * Blank lines and lines starting with <tt>#</tt> are ignored. It is also
- * permitted to include a comment starting with <tt>#</tt> after the value.
- *
- * @par Example
- * @code boost::asio::io_context my_io_context{
- * boost::asio::config_from_string{
- * "scheduler.concurrency_hint=10\n"
- * "scheduler.locking=1"}}; @endcode
- */
- class config_from_string : public execution_context::service_maker
- {
- public:
- /// Construct with the default prefix "asio".
- explicit config_from_string(std::string s)
- : string_(static_cast<std::string&&>(s)),
- prefix_()
- {
- }
- /// Construct with a specified prefix.
- config_from_string(std::string s, std::string prefix)
- : string_(static_cast<std::string&&>(s)),
- prefix_(static_cast<std::string&&>(prefix))
- {
- }
- /// Add a concrete service to the specified execution context.
- BOOST_ASIO_DECL void make(execution_context& ctx) const override;
- private:
- std::string string_;
- std::string prefix_;
- };
- /// Configures an execution context by reading environment variables.
- /**
- * The environment variable names are formed by concatenating the prefix,
- * section, and key, with underscore as delimiter, and then converting the
- * resulting string to upper case.
- *
- * @par Example
- * @code boost::asio::io_context my_io_context{
- * boost::asio::config_from_env{"my_app"}}; @endcode
- */
- class config_from_env : public execution_context::service_maker
- {
- public:
- /// Construct with the default prefix "asio".
- BOOST_ASIO_DECL config_from_env();
- /// Construct with a specified prefix.
- explicit config_from_env(std::string prefix)
- : prefix_(static_cast<std::string&&>(prefix))
- {
- }
- /// Add a concrete service to the specified execution context.
- BOOST_ASIO_DECL void make(execution_context& ctx) const override;
- private:
- std::string prefix_;
- };
- } // namespace asio
- } // namespace boost
- #include <boost/asio/detail/pop_options.hpp>
- #include <boost/asio/impl/config.hpp>
- #if defined(BOOST_ASIO_HEADER_ONLY)
- # include <boost/asio/impl/config.ipp>
- #endif // defined(BOOST_ASIO_HEADER_ONLY)
- #endif // BOOST_ASIO_CONFIG_HPP
|