Akonadi

dbustracer.h
1/***************************************************************************
2 * SPDX-FileCopyrightText: 2006 Tobias Koenig <tokoe@kde.org> *
3 * *
4 * SPDX-License-Identifier: LGPL-2.0-or-later *
5 ***************************************************************************/
6
7#pragma once
8
9#include <QObject>
10
11#include "tracerinterface.h"
12
13namespace Akonadi
14{
15namespace Server
16{
17/**
18 * A tracer which forwards all tracing information as dbus signals.
19 */
20class DBusTracer : public QObject, public TracerInterface
21{
23
24public:
25 DBusTracer();
26 ~DBusTracer() override;
27
28 void beginConnection(const QString &identifier, const QString &msg) override;
29 void endConnection(const QString &identifier, const QString &msg) override;
30 void connectionInput(const QString &identifier, const QByteArray &msg) override;
31 void connectionOutput(const QString &identifier, const QByteArray &msg) override;
32 void signal(const QString &signalName, const QString &msg) override;
33 void warning(const QString &componentName, const QString &msg) override;
34 void error(const QString &componentName, const QString &msg) override;
35
36 TracerInterface::ConnectionFormat connectionFormat() const override
37 {
38 return TracerInterface::Json;
39 }
40
42 void connectionStarted(const QString &identifier, const QString &msg);
43 void connectionEnded(const QString &identifier, const QString &msg);
44 void connectionDataInput(const QString &identifier, const QString &msg);
45 void connectionDataOutput(const QString &identifier, const QString &msg);
46 void signalEmitted(const QString &signalName, const QString &msg);
47 void warningEmitted(const QString &componentName, const QString &msg);
48 void errorEmitted(const QString &componentName, const QString &msg);
49};
50
51} // namespace Server
52} // namespace Akonadi
A tracer which forwards all tracing information as dbus signals.
Definition dbustracer.h:21
void error(const QString &componentName, const QString &msg) override
This method is called whenever a component wants to output an error.
void beginConnection(const QString &identifier, const QString &msg) override
This method is called whenever a new data (imap) connection to the akonadi server is established.
void warning(const QString &componentName, const QString &msg) override
This method is called whenever a component wants to output a warning.
void signal(const QString &signalName, const QString &msg) override
This method is called whenever a dbus signal is emitted on the bus.
void connectionInput(const QString &identifier, const QByteArray &msg) override
This method is called whenever the akonadi server retrieves some data from the outside.
void connectionOutput(const QString &identifier, const QByteArray &msg) override
This method is called whenever the akonadi server sends some data out to a client.
void endConnection(const QString &identifier, const QString &msg) override
This method is called whenever a data (imap) connection to akonadi server is closed.
This interface can be reimplemented to deliver tracing information of the akonadi server to the outsi...
Helper integration between Akonadi and Qt.
Q_OBJECTQ_OBJECT
Q_SIGNALSQ_SIGNALS
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sat Dec 21 2024 17:01:42 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.