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