include/anna/core/tracing/TraceLogger.hpp

   1 // ANNA - Anna is Not Nothingness 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_TraceLogger_hpp
  38 #define anna_core_tracing_TraceLogger_hpp
  39
  40 #include <anna/core/tracing/Logger.hpp>
  41
  42 namespace anna {
  43
  44 /**
  45    Clase usada por defecto para transferir los datos de la aplicacion al archivo de log.
  46
  47    Para mas informacion:
  48       @li man syslog
  49       @li man syslogd
  50       @li man syslog.conf
  51
  52    El destino del archivos de logs sera configurado mediante el archivo /etc/syslog.conf
  53
  54    Ésta clase se registra como la facilidad (local0).
  55
  56    \warning Sustituye a la clase Logger::DefaultWriter.
  57 */
  58 class TraceLogger : public Logger::Writer {
  59 private:
  60   /**
  61      Inicializa el sistema de historico de nuestra aplicacion.
  62
  63      @param ident Identifica las trazas de nuestra aplicacion que apareceran  en el archivo de historico.
  64      Deberia ser un texto con entre 4 y 16 caracteres.
  65   */
  66   void initialize(const char* ident) throw();
  67
  68   /**
  69      Transfiere el mensaje de trazas al log del sistema.
  70
  71      @param level Nivel de las trazas que vamos a sacar.
  72      @param text Especificacion de formato del mensaje. Similar al usado en el comando sprintf.
  73   */
  74   void do_write(int level, const char* text, ...) throw();
  75 };
  76
  77 }
  78
  79 #endif
  80
  81