include/anna/core/mt/Resource.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_core_mt_Resource_hpp
  10 #define anna_core_mt_Resource_hpp
  11
  12 #include <anna/core/mt/Mutex.hpp>
  13 #include <anna/core/mt/Guard.hpp>
  14 #include <anna/config/defines.hpp>
  15 #include <anna/core/util/Millisecond.hpp>
  16
  17 namespace anna {
  18
  19 namespace xml {
  20 class Node;
  21 }
  22
  23 /**
  24    Clase que modela un recurso de acceso compartido.
  25 */
  26 class Resource : public Mutex {
  27 public:
  28   /**
  29      Constructor.
  30      \param name Nombre logico de este recurso remoto.
  31      \param mode Modo de actuacion de esta instancia en modo ST cuando montamos una seccion critca sobre este objeto.
  32      En modo MT siempre sera Mode::Normal, es decir abre una seccion critica sobre este objeto, que bloqueara a
  33      cualquier otro thread que intente acceder a el.
  34   */
  35   Resource(const std::string& name) :
  36     Mutex(),
  37     a_name(name),
  38     a_isEnabled(true),
  39     a_timeStamp(0)
  40   {;}
  41
  42   /**
  43      Devuelve el nombre logico de este recurso remoto.
  44      @return El nombre logico de este recurso remoto.
  45   */
  46   const std::string& getName() const throw() { return a_name; }
  47
  48   /**
  49      Devuelve el estado referente a la habilitacion de este recurso.
  50
  51      La habilitacion o inhabilitacion responde a causas externas a este recurso, es decir, puede ser
  52      que el recurso estaria preparado pero por algun motivo deseamos marcarlo como "no usable".
  53
  54      Para que un recurso pueda ser usado tanto este metodo como #isAvailable deberan retornar \em true.
  55
  56      \return \em true Si el recurso esta habilitado o \em false en otro caso.
  57   */
  58   bool isEnabled() const throw() { return a_isEnabled; }
  59
  60   /**
  61   * Obtiene el valor de la marca de tiempo asociada a este recurso. Se usa desde las clases
  62   * de reparto de carga, para marca el momento en que ha sido desactivado el recurso, lo permite
  63   * volver a comprobar el recurso cada cierto periodo de tiempo.
  64   *
  65   * \param timeStamp Marca de tiempo asociada al recurso.
  66   */
  67   void setTimeStamp(const Millisecond &timeStamp) throw() { a_timeStamp = timeStamp; }
  68
  69   /*
  70   * Devuelve la marca de tiempo asociada al recurso.
  71   * \return la marca de tiempo asociada al recurso.
  72   */
  73   const Millisecond &getTimeStamp() const throw() { return a_timeStamp; }
  74
  75   /**
  76      Operador de comparacion.
  77      \param name Nombre con el que comparar.
  78      \return Devuelve \em true si el nombre recibido como parametro coincide con el
  79      indicado en el constructor de esta instancia o \em false en caso contrario.
  80   */
  81   bool operator == (const std::string& name) const throw() { return a_name == name; }
  82
  83   /**
  84      Operador de comparacion.
  85      \param other Instancia con la que comparar.
  86      \return Devuelve \em true si el nombre recibido como parametro coincide con el
  87      indicado en el constructor de esta instancia o \em false en caso contrario.
  88   */
  89   bool operator == (const Resource& other) const throw() { return a_name == other.a_name; }
  90
  91   /**
  92      Habilita el uso de este recurso.
  93      Si no se indica lo contrario un recurso remoto siempre se encuentra habilitado, pero no tiene por que estar
  94      disponible.
  95      \warning La invocacion a este metodo deberia hacerse en modo exclusivo.
  96   */
  97   void enable() throw(RuntimeException)  { Guard guard(this, "Resource"); a_isEnabled = true;   }
  98
  99   /**
 100      Evita el uso de este recurso.
 101      \warning La invocacion a este metodo deberia hacerse en modo exclusivo.
 102   */
 103   void disable() throw(RuntimeException)  { Guard guard(this, "Resource"); a_isEnabled = false;  }
 104
 105   /**
 106      Devuelve una cadena con la informacin referente a este recurso remoto.
 107      @return Una cadena con la informacin referente a este recurso remoto.
 108   */
 109   virtual std::string asString() const throw();
 110
 111   /**
 112      Devuelve el estado de disponibilidad de este recurso.
 113
 114      El recurso no esta preparado para ser usado debido a causas internas.
 115
 116      Para que un recurso pueda ser usado tanto este metodo como #isEnabled deberan retornar \em true.
 117
 118      @return \em false si el recurso no esta preparado para ser usado debido a causas internas o
 119       \em true en otro caso.
 120   */
 121   virtual bool isAvailable() const throw(RuntimeException) = 0;
 122
 123 private:
 124   const std::string a_name;
 125   bool a_isEnabled;
 126   Millisecond a_timeStamp;
 127 };
 128
 129 }
 130
 131 #endif