error.h 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151
  1. /*
  2. * Copyright (c) 2015, 2018, Oracle and/or its affiliates. All rights reserved.
  3. *
  4. * This program is free software; you can redistribute it and/or modify
  5. * it under the terms of the GNU General Public License, version 2.0, as
  6. * published by the Free Software Foundation.
  7. *
  8. * This program is also distributed with certain software (including
  9. * but not limited to OpenSSL) that is licensed under separate terms,
  10. * as designated in a particular file or component or in included license
  11. * documentation. The authors of MySQL hereby grant you an
  12. * additional permission to link the program and your derivative works
  13. * with the separately licensed software that they have included with
  14. * MySQL.
  15. *
  16. * Without limiting anything contained in the foregoing, this file,
  17. * which is part of MySQL Connector/C++, is also subject to the
  18. * Universal FOSS Exception, version 1.0, a copy of which can be found at
  19. * http://oss.oracle.com/licenses/universal-foss-exception.
  20. *
  21. * This program is distributed in the hope that it will be useful, but
  22. * WITHOUT ANY WARRANTY; without even the implied warranty of
  23. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  24. * See the GNU General Public License, version 2.0, for more details.
  25. *
  26. * You should have received a copy of the GNU General Public License
  27. * along with this program; if not, write to the Free Software Foundation, Inc.,
  28. * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  29. */
  30. #ifndef MYSQLX_ERROR_H
  31. #define MYSQLX_ERROR_H
  32. /**
  33. @file
  34. Classes used to access query and command execution results.
  35. */
  36. #include "common.h"
  37. #include "detail/error.h"
  38. #include <memory>
  39. namespace mysqlx {
  40. /**
  41. An error, warning or other diagnostic information reported by server
  42. when executing queries or statements. The information can be printed to
  43. output stream using `<<` operator.
  44. @note Normally, errors reported by server are not represented by `Warning`
  45. instances but instead they are thrown as instances of `mysqlx::Error`.
  46. @ingroup devapi
  47. */
  48. class Warning
  49. : public virtual common::Printable
  50. , internal::Warning_detail
  51. {
  52. public:
  53. /// Type of diagnostic information.
  54. enum Level {
  55. LEVEL_ERROR, ///< %Error
  56. LEVEL_WARNING, ///< %Warning
  57. LEVEL_INFO ///< Other information
  58. };
  59. private:
  60. Warning(Level level, uint16_t code, const string &msg)
  61. : Warning_detail(byte(level),code,msg)
  62. {
  63. }
  64. Warning(Warning_detail &&init)
  65. : Warning_detail(std::move(init))
  66. {}
  67. void print(std::ostream &out) const
  68. {
  69. try {
  70. Warning_detail::print(out);
  71. }
  72. CATCH_AND_WRAP
  73. }
  74. public:
  75. /**
  76. Return level of the diagnostic info stored in this object.
  77. */
  78. Level getLevel() const
  79. {
  80. return Level(m_level);
  81. }
  82. /**
  83. Return error/warning code reported by server.
  84. */
  85. uint16_t getCode() const
  86. {
  87. return m_code;
  88. }
  89. /**
  90. Return diagnostic message reported by server.
  91. */
  92. const string& getMessage() const
  93. {
  94. return m_msg;
  95. }
  96. ///@cond IGNORE
  97. friend internal::Result_detail;
  98. ///@endcond
  99. struct Access;
  100. friend Access;
  101. };
  102. inline
  103. void internal::Warning_detail::print(std::ostream &out) const
  104. {
  105. switch (Warning::Level(m_level))
  106. {
  107. case Warning::LEVEL_ERROR: out << "Error"; break;
  108. case Warning::LEVEL_WARNING: out << "Warning"; break;
  109. case Warning::LEVEL_INFO: out << "Info"; break;
  110. default: out << "<Unknown>"; break;
  111. }
  112. if (m_code)
  113. out << " " << m_code;
  114. out << ": " << m_msg;
  115. }
  116. } // mysqlx
  117. #endif