Akonadi::Server::TracerInterface
#include <tracerinterface.h>
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 27 of file tracerinterface.h.
Member Enumeration Documentation
◆ ConnectionFormat
enum Akonadi::Server::TracerInterface::ConnectionFormat |
Definition at line 30 of file tracerinterface.h.
Member Function Documentation
◆ beginConnection()
|
pure virtual |
This method is called whenever a new data (imap) connection to the akonadi server is established.
- Parameters
-
identifier The unique identifier for this connection. All input and output messages for this connection will have the same identifier. msg A message specific string.
Implemented in Akonadi::Server::DBusTracer, and Akonadi::Server::FileTracer.
◆ connectionFormat()
|
inlinevirtual |
Definition at line 94 of file tracerinterface.h.
◆ connectionInput()
|
pure virtual |
This method is called whenever the akonadi server retrieves some data from the outside.
- Parameters
-
identifier The unique identifier of the connection on which the data is retrieved. msg A message specific string.
Implemented in Akonadi::Server::DBusTracer, and Akonadi::Server::FileTracer.
◆ connectionOutput()
|
pure virtual |
This method is called whenever the akonadi server sends some data out to a client.
- Parameters
-
identifier The unique identifier of the connection on which the data is send. msg A message specific string.
Implemented in Akonadi::Server::DBusTracer, and Akonadi::Server::FileTracer.
◆ endConnection()
|
pure virtual |
This method is called whenever a data (imap) connection to akonadi server is closed.
- Parameters
-
identifier The unique identifier of this connection. msg A message specific string.
Implemented in Akonadi::Server::DBusTracer, and Akonadi::Server::FileTracer.
◆ error()
|
pure virtual |
This method is called whenever a component wants to output an error.
Implemented in Akonadi::Server::DBusTracer, and Akonadi::Server::FileTracer.
◆ signal()
|
pure virtual |
This method is called whenever a dbus signal is emitted on the bus.
- Parameters
-
signalName The name of the signal being sent. msg A message specific string.
Implemented in Akonadi::Server::DBusTracer, and Akonadi::Server::FileTracer.
◆ warning()
|
pure virtual |
This method is called whenever a component wants to output a warning.
Implemented in Akonadi::Server::DBusTracer, and Akonadi::Server::FileTracer.
The documentation for this class was generated from the following file:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Oct 4 2024 11:57:22 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.