Akonadi::Server::TracerInterface

Akonadi::Server::TracerInterface Class Referenceabstract

#include <tracerinterface.h>

Inheritance diagram for Akonadi::Server::TracerInterface:

Public Types

enum  ConnectionFormat { DebugString, Json }
 

Public Member Functions

virtual void beginConnection (const QString &identifier, const QString &msg)=0
 
virtual ConnectionFormat connectionFormat () const
 
virtual void connectionInput (const QString &identifier, const QByteArray &msg)=0
 
virtual void connectionOutput (const QString &identifier, const QByteArray &msg)=0
 
virtual void endConnection (const QString &identifier, const QString &msg)=0
 
virtual void error (const QString &componentName, const QString &msg)=0
 
virtual void signal (const QString &signalName, const QString &msg)=0
 
virtual void warning (const QString &componentName, const QString &msg)=0
 

Detailed Description

This interface can be reimplemented to deliver tracing information of the akonadi server to the outside.

Possible implementations:

  • log file
  • dbus signals
  • live gui

Definition at line 40 of file tracerinterface.h.

Member Function Documentation

virtual void Akonadi::Server::TracerInterface::beginConnection ( const QString identifier,
const QString msg 
)
pure virtual

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.

Implemented in Akonadi::Server::DBusTracer, Akonadi::Server::FileTracer, and Akonadi::Server::NullTracer.

virtual void Akonadi::Server::TracerInterface::connectionInput ( const QString identifier,
const QByteArray msg 
)
pure virtual

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.

Implemented in Akonadi::Server::NullTracer, Akonadi::Server::DBusTracer, and Akonadi::Server::FileTracer.

virtual void Akonadi::Server::TracerInterface::connectionOutput ( const QString identifier,
const QByteArray msg 
)
pure virtual

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.

Implemented in Akonadi::Server::NullTracer, Akonadi::Server::DBusTracer, and Akonadi::Server::FileTracer.

virtual void Akonadi::Server::TracerInterface::endConnection ( const QString identifier,
const QString msg 
)
pure virtual

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.

Implemented in Akonadi::Server::DBusTracer, Akonadi::Server::FileTracer, and Akonadi::Server::NullTracer.

virtual void Akonadi::Server::TracerInterface::error ( const QString componentName,
const QString msg 
)
pure virtual

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

Implemented in Akonadi::Server::NullTracer, Akonadi::Server::DBusTracer, and Akonadi::Server::FileTracer.

virtual void Akonadi::Server::TracerInterface::signal ( const QString signalName,
const QString msg 
)
pure virtual

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.

Implemented in Akonadi::Server::NullTracer, Akonadi::Server::DBusTracer, and Akonadi::Server::FileTracer.

virtual void Akonadi::Server::TracerInterface::warning ( const QString componentName,
const QString msg 
)
pure virtual

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

Implemented in Akonadi::Server::NullTracer, Akonadi::Server::DBusTracer, and Akonadi::Server::FileTracer.


The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 1 2020 23:08:00 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.