utility/setup/from_stream.hpp

0001 /*
0002  *          Copyright Andrey Semashev 2007 - 2015.
0003  * Distributed under the Boost Software License, Version 1.0.
0004  *    (See accompanying file LICENSE_1_0.txt or copy at
0005  *          http://www.boost.org/LICENSE_1_0.txt)
0006  */
0007 /*!
0008  * \file   from_stream.hpp
0009  * \author Andrey Semashev
0010  * \date   22.03.2008
0011  *
0012  * The header contains definition of facilities that allows to initialize the library from a
0013  * settings file.
0014  */
0015
0016 #ifndef BOOST_LOG_UTILITY_SETUP_FROM_STREAM_HPP_INCLUDED_
0017 #define BOOST_LOG_UTILITY_SETUP_FROM_STREAM_HPP_INCLUDED_
0018
0019 #include <iosfwd>
0020 #include <boost/log/detail/setup_config.hpp>
0021 #include <boost/log/detail/header.hpp>
0022
0023 #ifdef BOOST_HAS_PRAGMA_ONCE
0024 #pragma once
0025 #endif
0026
0027 namespace boost {
0028
0029 BOOST_LOG_OPEN_NAMESPACE
0030
0031 /*!
0032  * The function initializes the logging library from a stream containing logging settings
0033  *
0034  * \param strm Stream, that provides library settings
0035  *
0036  * \b Throws: An <tt>std::exception</tt>-based exception if the read data cannot be interpreted as the library settings
0037  */
0038 template< typename CharT >
0039 BOOST_LOG_SETUP_API void init_from_stream(std::basic_istream< CharT >& strm);
0040
0041 BOOST_LOG_CLOSE_NAMESPACE // namespace log
0042
0043 } // namespace boost
0044
0045 #include <boost/log/detail/footer.hpp>
0046
0047 #endif // BOOST_LOG_UTILITY_SETUP_FROM_STREAM_HPP_INCLUDED_