driver.h 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106
  1. /*
  2. * Copyright (c) 2008, 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 _SQL_DRIVER_H_
  31. #define _SQL_DRIVER_H_
  32. #include "connection.h"
  33. #include "build_config.h"
  34. #include "callback.h"
  35. namespace sql
  36. {
  37. class CPPCONN_PUBLIC_FUNC Driver
  38. {
  39. protected:
  40. virtual ~Driver() {}
  41. public:
  42. // Attempts to make a database connection to the given URL.
  43. virtual Connection * connect(const sql::SQLString& hostName, const sql::SQLString& userName, const sql::SQLString& password) = 0;
  44. virtual Connection * connect(ConnectOptionsMap & options) = 0;
  45. virtual int getMajorVersion() = 0;
  46. virtual int getMinorVersion() = 0;
  47. virtual int getPatchVersion() = 0;
  48. virtual const sql::SQLString & getName() = 0;
  49. virtual void setCallBack(sql::Fido_Callback &cb) = 0;
  50. virtual void setCallBack(sql::Fido_Callback &&cb) = 0;
  51. virtual void threadInit() = 0;
  52. virtual void threadEnd() = 0;
  53. virtual void setCallBack(sql::WebAuthn_Callback &cb) = 0;
  54. virtual void setCallBack(sql::WebAuthn_Callback &&cb) = 0;
  55. };
  56. } /* namespace sql */
  57. CPPCONN_PUBLIC_FUNC void check(const std::string &);
  58. CPPCONN_PUBLIC_FUNC void check(const std::map<std::string,std::string> &);
  59. /*
  60. Checks if user standard lib is compatible with connector one
  61. */
  62. inline static void check_lib()
  63. {
  64. check(std::string{});
  65. check(std::map<std::string,std::string>{});
  66. }
  67. extern "C"
  68. {
  69. CPPCONN_PUBLIC_FUNC sql::Driver * _get_driver_instance_by_name(const char * const clientlib);
  70. /* If dynamic loading is disabled in a driver then this function works just like get_driver_instance() */
  71. inline static sql::Driver * get_driver_instance_by_name(const char * const clientlib)
  72. {
  73. check_lib();
  74. return _get_driver_instance_by_name(clientlib);
  75. }
  76. inline static sql::Driver * get_driver_instance()
  77. {
  78. return get_driver_instance_by_name("");
  79. }
  80. }
  81. #endif /* _SQL_DRIVER_H_ */