Akonadi::Server::Tracer

Search for usage in LXR

Akonadi::Server::Tracer Class Reference

#include <tracer.h>

Inheritance diagram for Akonadi::Server::Tracer:

Public Slots

void activateTracer (const QString &type)
 
void beginConnection (const QString &identifier, const QString &msg) override
 
void connectionInput (const QString &identifier, const QByteArray &msg) override
 
void connectionInput (const QString &identifier, qint64 tag, const Protocol::CommandPtr &cmd)
 
void connectionOutput (const QString &identifier, const QByteArray &msg) override
 
void connectionOutput (const QString &identifier, qint64 tag, const Protocol::CommandPtr &cmd)
 
void endConnection (const QString &identifier, const QString &msg) override
 
void error (const char *componentName, const QString &msg)
 
void error (const QString &componentName, const QString &msg) override
 
void signal (const char *signalName, const QString &msg)
 
void signal (const QString &signalName, const QString &msg) override
 
void warning (const QString &componentName, const QString &msg) override
 

Public Member Functions

 ~Tracer () override
 
template<typename T >
std::enable_if< std::is_base_of< Protocol::Command, T >::value >::type connectionOutput (const QString &identifier, qint64 tag, const T &cmd)
 
QString currentTracer () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 
- Public Member Functions inherited from Akonadi::Server::TracerInterface
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
 

Additional Inherited Members

- Public Types inherited from Akonadi::Server::TracerInterface
enum  ConnectionFormat { DebugString, Json }
 
- Properties inherited from QObject
 objectName
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

The global tracer instance where all akonadi components can send their tracing information to.

The tracer will forward these information to the configured backends.

Definition at line 37 of file tracer.h.

Constructor & Destructor Documentation

◆ ~Tracer()

Tracer::~Tracer ( )
overridedefault

Destroys the global tracer instance.

Member Function Documentation

◆ activateTracer

void Tracer::activateTracer ( const QString type)
slot

Activates the given tracer type.

Definition at line 144 of file tracer.cpp.

◆ beginConnection

void Tracer::beginConnection ( const QString identifier,
const QString msg 
)
overrideslot

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.

Definition at line 37 of file tracer.cpp.

◆ connectionInput

void Tracer::connectionInput ( const QString identifier,
const QByteArray msg 
)
overrideslot

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.

Definition at line 53 of file tracer.cpp.

◆ connectionOutput

void Tracer::connectionOutput ( const QString identifier,
const QByteArray msg 
)
overrideslot

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.

Definition at line 79 of file tracer.cpp.

◆ currentTracer()

QString Tracer::currentTracer ( ) const

Returns the currently activated tracer type.

Definition at line 138 of file tracer.cpp.

◆ endConnection

void Tracer::endConnection ( const QString identifier,
const QString msg 
)
overrideslot

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.

Definition at line 45 of file tracer.cpp.

◆ error [1/2]

void Tracer::error ( const char *  componentName,
const QString msg 
)
slot

Convenience method for QT_NO_CAST_FROM_ASCII usage.

Definition at line 133 of file tracer.cpp.

◆ error [2/2]

void Tracer::error ( const QString componentName,
const QString msg 
)
overrideslot

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

Definition at line 125 of file tracer.cpp.

◆ signal [1/2]

void Tracer::signal ( const char *  signalName,
const QString msg 
)
slot

Convenience method with internal toLatin1 cast to compile with QT_NO_CAST_FROM_ASCII.

Definition at line 112 of file tracer.cpp.

◆ signal [2/2]

void Tracer::signal ( const QString signalName,
const QString msg 
)
overrideslot

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.

Definition at line 104 of file tracer.cpp.

◆ warning

void Tracer::warning ( const QString componentName,
const QString msg 
)
overrideslot

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

Definition at line 117 of file tracer.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.