ANNA Suite  2020b
Multipurpose development suite for Telco applications
Classes | Public Member Functions | Static Public Attributes | List of all members
anna::TraceWriter Class Reference

#include <TraceWriter.hpp>

Inheritance diagram for anna::TraceWriter:
Inheritance graph
[legend]
Collaboration diagram for anna::TraceWriter:
Collaboration graph
[legend]

Public Member Functions

 TraceWriter ()
 
 TraceWriter (const char *fileName, const int maxSize)
 
int getMaxSize () const
 
void setup (const char *fileName, const Configuration &configuration)
 
void setup (const char *fileName, const int maxSize=0, const bool clean=true)
 
void printResume ()
 
void attach (TraceWriterObserver *observer)
 
- Public Member Functions inherited from anna::Logger::Writer
virtual ~Writer ()
 

Static Public Attributes

static const int DefaultMaxKBSize = 4192 * 1024
 

Additional Inherited Members

- Protected Member Functions inherited from anna::Logger::Writer
 Writer (const int bufferSize)
 
 Writer ()
 
DataBlockgetDataBlock ()
 

Detailed Description

Grabador de trazas

See also
Logger

Constructor & Destructor Documentation

◆ TraceWriter() [1/2]

anna::TraceWriter::TraceWriter ( )

Constructor.

Warning
Si se usa este constructor las trazas se escribiran en un fichero del directorio temporal con el mismo nombre que el pid del proceso.

◆ TraceWriter() [2/2]

anna::TraceWriter::TraceWriter ( const char *  fileName,
const int  maxSize 
)

Constructor.

Parameters
fileNameNombre del fichero de trazas.
maxSizeTama�o maximo del fichero de trazas expresando en bytes.

Member Function Documentation

◆ attach()

void anna::TraceWriter::attach ( TraceWriterObserver observer)

Conecta esta instancia con un TraceWriterObserver, lo que permitira que esta instancia conozca cuando se abre o cierra el fichero asociado a la escritura de trazas.

Este metodo puede invocarse tantas veces como sea necesario con distintas instancias de observador.

Parameters
observerInstancia del observador que recibira las notificaciones de apertura y cierre del fichero usado para sacar las trazas.
Warning
La instancia del TraceWriterObserver debera estar disponible durante toda la ejecucion.

◆ getMaxSize()

int anna::TraceWriter::getMaxSize ( ) const
inline

Devuelve el tama�o maximo del fichero de trazas.

Returns
El tama�o maximo del fichero de trazas.
50 { return a_maxSize; }
Here is the call graph for this function:

◆ printResume()

void anna::TraceWriter::printResume ( )

Saca por pantalla la informacion relevente de este grabador de trazas.

◆ setup() [1/2]

void anna::TraceWriter::setup ( const char *  fileName,
const Configuration configuration 
)

Metodo para cambiar dinamicamente la configuracion del grabador de trazas. Las seccciones requeridas para el archivo de configuracion seran:

[Trace]
MaxFileSize = Kbytes maximo de los ficheros de trazas. Por defecto sera 4096 Kbytes
Level = Nivel de trazas con el que comenzar la configuracion. Por defecto sera Debug para las
versiones con depuracion y Error para las versiones definitivas.
Clean = Un 1 indica que los ficheros de trazas usados hasta el momento deben borrarse y un 0
indica que deben mantenerse. Por defecto sera 1.

Todos los parametros de la seccion Trace son opcionales.

Parameters
fileNameNombre del fichero de trazas.
configurationConfiguracion que contiene las variables y secciones necesarias para establecer la configuracion desea del grabador de trazas.
Warning
La configuracion debera estar correctamente cargada. Ver Configuration::load.

◆ setup() [2/2]

void anna::TraceWriter::setup ( const char *  fileName,
const int  maxSize = 0,
const bool  clean = true 
)

Metodo para cambiar dinamicamente la configuracion del grabador de trazas.

Parameters
fileNameNombre del fichero de trazas.
maxSizeTama�o maximo del fichero de trazas expresando en bytes. Un valor 0 mantiene el valor del tama�o estahlecido hasta el momento.
cleantrue Indica que los ficheros de trazas usados hasta el momento deben borrase, false indica que los ficheros de trazas deben mantenerse.
Warning
Solo deberia llamarse una vez para cambiar de la configuracion por defecto a la configuracion particular de cada proceso.

Member Data Documentation

◆ DefaultMaxKBSize

const int anna::TraceWriter::DefaultMaxKBSize = 4192 * 1024
static

The documentation for this class was generated from the following file: