include/anna/dbms.mysql/Connection.hpp

   1 // ANNA - Anna is Not 'N' Anymore
   2 //
   3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
   4 //
   5 // https://bitbucket.org/testillano/anna
   6 //
   7 // Redistribution and use in source and binary forms, with or without
   8 // modification, are permitted provided that the following conditions
   9 // are met:
  10 //
  11 //     * Redistributions of source code must retain the above copyright
  12 // notice, this list of conditions and the following disclaimer.
  13 //     * Redistributions in binary form must reproduce the above
  14 // copyright notice, this list of conditions and the following disclaimer
  15 // in the documentation and/or other materials provided with the
  16 // distribution.
  17 //     * Neither the name of Google Inc. nor the names of its
  18 // contributors may be used to endorse or promote products derived from
  19 // this software without specific prior written permission.
  20 //
  21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 //
  33 // Authors: eduardo.ramos.testillano@gmail.com
  34 //          cisco.tierra@gmail.com
  35
  36
  37 #ifndef anna_dbms_mysql_Connection_hpp
  38 #define anna_dbms_mysql_Connection_hpp
  39
  40
  41 #include <anna/dbms/Connection.hpp>
  42 #include <anna/dbms/DatabaseException.hpp>
  43
  44 #include <anna/dbms.mysql/forward.hpp>
  45
  46 namespace anna {
  47
  48 namespace dbms {
  49
  50 class Database;
  51
  52 namespace mysql {
  53
  54 class Database;
  55
  56 /**
  57    Clase que modela la conexion con el RDBMS MySQL (tm).
  58
  59    Esta clase no puede usarse directamente, ya que la capa ANNA.dbms obliga a que todas las peticiones
  60    se hagan atraves de una instancia anna::dbms::Connection.
  61
  62    Para obtener una conexion a una determinada base de datos habra que instanciar dicha base de datos
  63    e invocar al metodo createConnection. Independientemente del tipo de conexion particular que la
  64    base de datos retorne, debemos asignarlo a un puntero de tipo anna::dbms::Connection.
  65 */
  66 class Connection : public dbms::Connection {
  67 public:
  68   /**
  69      Devuelve una cadena con la informacion referente a esta instancia.
  70      @return Una cadena con la informacion referente a esta instancia.
  71   */
  72   std::string asString() const throw();
  73
  74   /**
  75      Operador de conversion.
  76      \return El puntero al entorno asociado a esta base de datos.
  77   */
  78   operator st_mysql*() throw() { return a_mysql; }
  79
  80 private:
  81   Database& a_mysqlDatabase;
  82   st_mysql* a_mysql;
  83
  84   Connection(Database& database, const std::string& name, const char* user, const char* password);
  85
  86   bool isAvailable() const throw(RuntimeException) { return a_mysql != NULL; }
  87
  88   void do_commit() throw(RuntimeException, DatabaseException);
  89   void do_rollback() throw();
  90   void open() throw(DatabaseException);
  91   void close() throw();
  92
  93   friend class anna::dbms::mysql::Database;
  94 };
  95
  96 }
  97 }
  98 }
  99
 100 #endif