boost/mysql/is_fatal_error.hpp

0001 //
0002 // Copyright (c) 2019-2024 Ruben Perez Hidalgo (rubenperez038 at gmail dot com)
0003 //
0004 // Distributed under the Boost Software License, Version 1.0. (See accompanying
0005 // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
0006 //
0007
0008 #ifndef BOOST_MYSQL_IS_FATAL_ERROR_HPP
0009 #define BOOST_MYSQL_IS_FATAL_ERROR_HPP
0010
0011 #include <boost/mysql/error_code.hpp>
0012
0013 #include <boost/mysql/detail/config.hpp>
0014
0015 namespace boost {
0016 namespace mysql {
0017
0018 /**
0019  * \brief Checks whether an error requires re-connection.
0020  * \details
0021  * After an operation on an established connection (like executing a query) fails,
0022  * the connection may be usable for further operations (if the error was non-fatal)
0023  * or not (if the error was fatal). This function determines whether an error
0024  * code returned by a connection operation is fatal or not.
0025  * \n
0026  * To recover from a fatal error code, close and re-establish the connection.
0027  *
0028  * \par Exception safety
0029  * No-throw guarantee.
0030  */
0031 BOOST_MYSQL_DECL
0032 bool is_fatal_error(error_code ec) noexcept;
0033
0034 }  // namespace mysql
0035 }  // namespace boost
0036
0037 #ifdef BOOST_MYSQL_HEADER_ONLY
0038 #include <boost/mysql/impl/is_fatal_error.ipp>
0039 #endif
0040
0041 #endif