include/anna/core/tracing/TraceWriterObserver.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_tracing_TraceWriterObserver_hpp
  38 #define anna_core_tracing_TraceWriterObserver_hpp
  39
  40 #include <string>
  41
  42 namespace anna {
  43
  44 class TraceWriter;
  45
  46 /**
  47   Interfaz que permite conocer cuando el TraceWriter asociado a nuestro sistema de trazas
  48   abre o cierra el fichero que usa para la salida de datos.
  49
  50   Una vez asociado al TraceWriter esta instancia debera estar disponible durante toda
  51   la ejecucion.
  52
  53    \see TraceWriter::attach
  54 */
  55 class TraceWriterObserver {
  56 public:
  57   /**
  58      Devuelve el nombre logico de este observador.
  59   */
  60   const char* getName() const throw() { return a_name; }
  61
  62   /**
  63      Devuelve una cadena con la informacion relevante de esta clase.
  64      \return una cadena con la informacion relevante de esta clase.
  65   */
  66   std::string asString() const throw() {
  67     std::string result("anna::TraceWriterObserver { Name: ");
  68     result += a_name;
  69     return result += " }";
  70   }
  71
  72 protected:
  73   /**
  74      Constructor.
  75      \param name Nombre logico de este observador.
  76   */
  77   TraceWriterObserver(const char* name) : a_name(name) {;}
  78
  79   /**
  80      Metodo que hay que reescribir para tratar la notificacion de apertura del fichero de trazas.
  81      \param fd \em File \em Descriptor usado por TraceWriter para escribir en el fichero de salida.
  82      \warning El fichero usado para escribir las trazas puede abrirse un numero indeterminado
  83      de veces durante la ejecucion de nuestra aplicacion.
  84   */
  85   virtual void handleOpen(const int fd) throw() = 0;
  86
  87   /**
  88      Metodo que hay que reescribir para tratar la notificacion de cierre del fichero de trazas.
  89      \param fd \em File \em Descriptor usado hasta el momento por TraceWriter para escribir en el
  90      fichero de salida.
  91      \warning El fichero usado para escribir las trazas puede cerrar un numero indeterminado
  92      de veces durante la ejecucion de nuestra aplicacion.
  93   */
  94   virtual void handleClose(const int fd) throw() = 0;
  95
  96 private:
  97   const char* a_name;
  98
  99   friend class TraceWriter;
 100 };
 101
 102 }
 103
 104 #endif
 105
 106