include/anna/timex/TimeEventObserver.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_timex_TimeEventObserver_hpp
  38 #define anna_timex_TimeEventObserver_hpp
  39
  40 namespace anna {
  41
  42 namespace timex {
  43
  44 class TimeEvent;
  45 class Engine;
  46
  47 /**
  48    Clase base que se encarga de recibir las notificaciones basicas referentes al timex::TimeEvent.
  49
  50    Hemos comprobado que casi todos los procesos hay alguna entidad que se encarga de crear
  51    los timex::TimeEvent que van siendo necesarios, normalmente usando un anna::Recycler<T>,
  52    por lo que como minimo esta entidad tiene que preocuparse por cuando expiran los eventos
  53    temporales y por cuando se caducan, para poder liberar su espacio.
  54
  55    Para facilitar el tratamiento de notificaciones vamos a incorporar esta clase, por ahora solo
  56    recibe notificaciones de cuando se deja de usar un timex::TimeEvent, pero en el futuro podria
  57    recibir mas eventos.
  58
  59    \see timex::TimeEvent::setObserver
  60 */
  61 class TimeEventObserver {
  62 public:
  63   /**
  64      Constructor
  65      @param name Nombre logico de este alojador.
  66   */
  67   TimeEventObserver(const char* name) : a_name(name) {}
  68
  69   /**
  70      Devuelve una cadena con la informacion referente a este temporizador.
  71      \return Una cadena con la informacion referenta a este temporizador.
  72   */
  73   std::string asString() const
  74   throw() {
  75     std::string msg("timex::TimeEventObserver { Name: ");
  76     msg += a_name;
  77     return msg += " }";
  78   }
  79
  80 protected:
  81   /**
  82      Metodo virtual que debe reimplmentar para liberar el espacio reservado para el
  83      evento temporal recibido como parametro.
  84
  85      Se invoca cuando el timex::Engine deja de usar el evento temporal.
  86
  87      \param timeEvent Evento temporal a liberar.
  88   */
  89   virtual void release(timex::TimeEvent* timeEvent) throw() = 0;
  90
  91 private:
  92   std::string a_name;
  93
  94   friend class Engine;
  95 };
  96
  97 }
  98 }
  99
 100 #endif
 101
 102