Akonadi::Server::FileTracer

Search for usage in LXR

Akonadi::Server::FileTracer Class Reference

#include <filetracer.h>

Inheritance diagram for Akonadi::Server::FileTracer:

Public Member Functions

 FileTracer (const QString &fileName)
 
void beginConnection (const QString &identifier, const QString &msg) override
 
void connectionInput (const QString &identifier, const QByteArray &msg) override
 
void connectionOutput (const QString &identifier, const QByteArray &msg) override
 
void endConnection (const QString &identifier, const QString &msg) override
 
void error (const QString &componentName, const QString &msg) override
 
void signal (const QString &signalName, const QString &msg) override
 
void warning (const QString &componentName, const QString &msg) override
 
- Public Member Functions inherited from Akonadi::Server::TracerInterface
virtual ConnectionFormat connectionFormat () const
 

Additional Inherited Members

- Public Types inherited from Akonadi::Server::TracerInterface
enum  ConnectionFormat { DebugString, Json }
 

Detailed Description

A tracer which forwards all tracing information to a log file.

Definition at line 29 of file filetracer.h.

Member Function Documentation

◆ beginConnection()

void FileTracer::beginConnection ( const QString identifier,
const QString msg 
)
overridevirtual

This method is called whenever a new data (imap) connection to the akonadi server is established.

Parameters
identifierThe unique identifier for this connection. All input and output messages for this connection will have the same identifier.
msgA message specific string.

Implements Akonadi::Server::TracerInterface.

Definition at line 20 of file filetracer.cpp.

◆ connectionInput()

void FileTracer::connectionInput ( const QString identifier,
const QByteArray msg 
)
overridevirtual

This method is called whenever the akonadi server retrieves some data from the outside.

Parameters
identifierThe unique identifier of the connection on which the data is retrieved.
msgA message specific string.

Implements Akonadi::Server::TracerInterface.

Definition at line 30 of file filetracer.cpp.

◆ connectionOutput()

void FileTracer::connectionOutput ( const QString identifier,
const QByteArray msg 
)
overridevirtual

This method is called whenever the akonadi server sends some data out to a client.

Parameters
identifierThe unique identifier of the connection on which the data is send.
msgA message specific string.

Implements Akonadi::Server::TracerInterface.

Definition at line 35 of file filetracer.cpp.

◆ endConnection()

void FileTracer::endConnection ( const QString identifier,
const QString msg 
)
overridevirtual

This method is called whenever a data (imap) connection to akonadi server is closed.

Parameters
identifierThe unique identifier of this connection.
msgA message specific string.

Implements Akonadi::Server::TracerInterface.

Definition at line 25 of file filetracer.cpp.

◆ error()

void FileTracer::error ( const QString componentName,
const QString msg 
)
overridevirtual

This method is called whenever a component wants to output an error.

Implements Akonadi::Server::TracerInterface.

Definition at line 50 of file filetracer.cpp.

◆ signal()

void FileTracer::signal ( const QString signalName,
const QString msg 
)
overridevirtual

This method is called whenever a dbus signal is emitted on the bus.

Parameters
signalNameThe name of the signal being sent.
msgA message specific string.

Implements Akonadi::Server::TracerInterface.

Definition at line 40 of file filetracer.cpp.

◆ warning()

void FileTracer::warning ( const QString componentName,
const QString msg 
)
overridevirtual

This method is called whenever a component wants to output a warning.

Implements Akonadi::Server::TracerInterface.

Definition at line 45 of file filetracer.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Tue Aug 16 2022 04:00:10 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.