robot/include/asio2/bho/mysql/error_categories.hpp

//
// Copyright (c) 2019-2023 Ruben Perez Hidalgo (rubenperez038 at gmail 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 BHO_MYSQL_ERROR_CATEGORIES_HPP
#define BHO_MYSQL_ERROR_CATEGORIES_HPP

#include <asio2/bho/mysql/detail/config.hpp>

#include <asio/error.hpp>

namespace bho {
namespace mysql {

/**
 * \brief Returns the error_category associated to \ref client_errc.
 *
 * \par Exception safety
 * No-throw guarantee.
 *
 * \par Object lifetimes
 * The returned reference is always valid (points to a singleton).
 *
 * \par Thread safety
 * This function is thread-safe.
 */
BHO_MYSQL_DECL
const asio::error_category& get_client_category() noexcept;

/**
 * \brief Returns the error_category associated to \ref common_server_errc.
 *
 * \par Exception safety
 * No-throw guarantee.
 *
 * \par Object lifetimes
 * The returned reference is always valid (points to a singleton).
 *
 * \par Thread safety
 * This function is thread-safe.
 */
BHO_MYSQL_DECL
const asio::error_category& get_common_server_category() noexcept;

/**
 * \brief Returns the error_category associated to errors specific to MySQL.
 *
 * \par Exception safety
 * No-throw guarantee.
 *
 * \par Object lifetimes
 * The returned reference is always valid (points to a singleton).
 *
 * \par Thread safety
 * This function is thread-safe.
 */
BHO_MYSQL_DECL
const asio::error_category& get_mysql_server_category() noexcept;

/**
 * \brief Returns the error_category associated to errors specific to MariaDB.
 *
 * \par Exception safety
 * No-throw guarantee.
 *
 * \par Object lifetimes
 * The returned reference is always valid (points to a singleton).
 *
 * \par Thread safety
 * This function is thread-safe.
 */
BHO_MYSQL_DECL
const asio::error_category& get_mariadb_server_category() noexcept;

}  // namespace mysql
}  // namespace bho

#ifdef BHO_MYSQL_HEADER_ONLY
#include <asio2/bho/mysql/impl/error_categories.ipp>
#endif

#endif