include/anna/core/tracing/TraceWriterObserver.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_tracing_TraceWriterObserver_hpp
  10 #define anna_core_tracing_TraceWriterObserver_hpp
  11
  12 #include <string>
  13
  14 namespace anna {
  15
  16 class TraceWriter;
  17
  18 /**
  19   Interfaz que permite conocer cuando el TraceWriter asociado a nuestro sistema de trazas
  20   abre o cierra el fichero que usa para la salida de datos.
  21
  22   Una vez asociado al TraceWriter esta instancia debera estar disponible durante toda
  23   la ejecucion.
  24
  25    \see TraceWriter::attach
  26 */
  27 class TraceWriterObserver {
  28 public:
  29   /**
  30      Devuelve el nombre logico de este observador.
  31   */
  32   const char* getName() const { return a_name; }
  33
  34   /**
  35      Devuelve una cadena con la informacion relevante de esta clase.
  36      \return una cadena con la informacion relevante de esta clase.
  37   */
  38   std::string asString() const {
  39     std::string result("anna::TraceWriterObserver { Name: ");
  40     result += a_name;
  41     return result += " }";
  42   }
  43
  44 protected:
  45   /**
  46      Constructor.
  47      \param name Nombre logico de este observador.
  48   */
  49   TraceWriterObserver(const char* name) : a_name(name) {;}
  50
  51   /**
  52      Metodo que hay que reescribir para tratar la notificacion de apertura del fichero de trazas.
  53      \param fd \em File \em Descriptor usado por TraceWriter para escribir en el fichero de salida.
  54      \warning El fichero usado para escribir las trazas puede abrirse un numero indeterminado
  55      de veces durante la ejecucion de nuestra aplicacion.
  56   */
  57   virtual void handleOpen(const int fd)  = 0;
  58
  59   /**
  60      Metodo que hay que reescribir para tratar la notificacion de cierre del fichero de trazas.
  61      \param fd \em File \em Descriptor usado hasta el momento por TraceWriter para escribir en el
  62      fichero de salida.
  63      \warning El fichero usado para escribir las trazas puede cerrar un numero indeterminado
  64      de veces durante la ejecucion de nuestra aplicacion.
  65   */
  66   virtual void handleClose(const int fd)  = 0;
  67
  68 private:
  69   const char* a_name;
  70
  71   friend class TraceWriter;
  72 };
  73
  74 }
  75
  76 #endif
  77
  78