include/anna/dbms/Delivery.hpp

   1 // ANNA - Anna is Not Nothingness Anymore                                                         //
   2 //                                                                                                //
   3 // (c) Copyright 2005-2015 Eduardo Ramos Testillano & Francisco Ruiz Rayo                         //
   4 //                                                                                                //
   5 // See project site at http://redmine.teslayout.com/projects/anna-suite                           //
   6 // See accompanying file LICENSE or copy at http://www.teslayout.com/projects/public/anna.LICENSE //
   7
   8
   9 #ifndef anna_dbms_Delivery_hpp
  10 #define anna_dbms_Delivery_hpp
  11
  12 #include <anna/comm/Delivery.hpp>
  13
  14 namespace anna {
  15
  16 namespace dbms {
  17
  18 class Connection;
  19
  20 /**
  21    Agrupacion logica de conexiones con la base de datos. Reparte la carga de las transacciones contra
  22    la base de datos entre las distintas conexiones que contenga esta instancia. Ademas en caso de estar
  23    en una ejecucion con soporte para multithread (ver anna::functions::supportMultithread) asegura
  24    que cada uno de los threads siempre utiliza la misma conexion lo cual asegura el mantinimiento de la
  25    integridad de cada una de las transacciones de los threads.
  26 */
  27 class Delivery : comm::Delivery {
  28 public:
  29   /**
  30      Constructor.
  31      @param name Nombre logico de este grupo de conexiones.
  32   */
  33   Delivery(const char *name) : comm::Delivery(name) {;}
  34
  35   /**
  36      Crea automaticamente las conexiones a la base de datos recibida como parametro con el usuario/password
  37      indicado.
  38      \param database Instancia de la base de datos contra la que realizamos la conexion.
  39      \param prefixName Prefijo del nombre logico de la conexiones que vamos a crear. El resto del nombre vendra
  40      dado por el numero secuencial de la conexion.
  41      \param user Nombre del usuario con el que realizamos la conexion.
  42      \param password Codigo de acceso del usuario.
  43      \param n Numero de conexion a crear.
  44      \warning Recordar que el numero maximo de conexiones a una base de datos esta limitado por Database::maxConnection.
  45   */
  46   void createConnections(Database& database, const char* prefixName, const char* user, const char* password, const int n)
  47   throw(RuntimeException, DatabaseException);
  48
  49   /**
  50      Incorpora al conexion recibida como parametro a la agrupacion logica.
  51      \param connection Conexion que vamos a incorporar a la agrupacion logica.
  52   */
  53   void addConnection(Connection* connection) throw(RuntimeException) {
  54     this->add(connection);
  55     a_iiConnection = this->begin();
  56   }
  57
  58   /**
  59      Devuelve la instancia de la conexion a base de datos con la que debemos trabajar.
  60      @return la instancia de la conexion a base de datos con la que debemos trabajar.
  61      \warning La conexion debe ser bloqueada por el Thread que la recibe (ver anna::Guard) para asegurar que
  62      cualquier otro thread que intente acceder a ella queda bloqueado a la espera de que terminemos de
  63      trabajar sobre ella.
  64   */
  65   Connection& getConnection() throw(RuntimeException);
  66
  67 private:
  68   iterator a_iiConnection;
  69
  70   void do_initialize() throw() { a_iiConnection = begin(); }
  71   comm::Resource* do_apply() throw(RuntimeException);
  72   static Connection* connection(iterator& ii) { return (Connection*) comm::Delivery::resource(ii); }
  73
  74 };
  75
  76 }
  77 }
  78
  79 #endif