Akonadi::Server::PreprocessorInstance
#include <preprocessorinstance.h>
Public Member Functions | |
~PreprocessorInstance () override | |
Public Member Functions inherited from QObject | |
QObject (QObject *parent) | |
QBindable< QString > | bindableObjectName () |
bool | blockSignals (bool block) |
const QObjectList & | children () 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 () const const |
void | dumpObjectTree () const const |
QList< QByteArray > | dynamicPropertyNames () const const |
virtual bool | event (QEvent *e) |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name, 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 |
QList< T > | findChildren (Qt::FindChildOptions options) const const |
bool | inherits (const char *className) const const |
void | installEventFilter (QObject *filterObj) |
bool | isQuickItemType () const const |
bool | isWidgetType () const const |
bool | isWindowType () const const |
void | killTimer (int id) |
virtual const QMetaObject * | metaObject () const const |
void | moveToThread (QThread *targetThread) |
QString | objectName () const const |
void | objectNameChanged (const QString &objectName) |
QObject * | parent () const const |
QVariant | property (const char *name) const const |
Q_CLASSINFO (Name, Value) | |
Q_EMIT Q_EMIT | |
Q_ENUM (...) | |
Q_ENUM_NS (...) | |
Q_ENUMS (...) | |
Q_FLAG (...) | |
Q_FLAG_NS (...) | |
Q_FLAGS (...) | |
Q_GADGET Q_GADGET | |
Q_GADGET_EXPORT (EXPORT_MACRO) | |
Q_INTERFACES (...) | |
Q_INVOKABLE Q_INVOKABLE | |
Q_MOC_INCLUDE Q_MOC_INCLUDE | |
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 | |
T | qobject_cast (const QObject *object) |
T | 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 | setObjectName (QAnyStringView name) |
void | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | setProperty (const char *name, QVariant &&value) |
bool | signalsBlocked () const const |
int | startTimer (int interval, Qt::TimerType timerType) |
int | startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType) |
QThread * | thread () const const |
Protected Member Functions | |
PreprocessorInstance (const QString &id, PreprocessorManager &manager, Tracer &tracer) | |
bool | abortProcessing () |
qint64 | currentProcessingTime () |
void | enqueueItem (qint64 itemId) |
const QString & | id () const |
bool | init () |
bool | invokeRestart () |
bool | isBusy () const |
std::deque< qint64 > * | itemQueue () |
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 |
QObject * | sender () const const |
int | senderSignalIndex () const const |
virtual void | timerEvent (QTimerEvent *event) |
Additional Inherited Members | |
Public Types inherited from QObject | |
typedef | QObjectList |
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) |
Detailed Description
A single preprocessor (agent) instance.
Most of the interface of this class is protected and is exposed only to PreprocessorManager (singleton).
This class is NOT thread safe. The caller is responsible of protecting against concurrent access.
Definition at line 38 of file preprocessorinstance.h.
Constructor & Destructor Documentation
◆ PreprocessorInstance()
|
protected |
Create an instance of a PreprocessorInstance descriptor.
Definition at line 29 of file preprocessorinstance.cpp.
◆ ~PreprocessorInstance()
|
overridedefault |
Destroy this instance of the PreprocessorInstance descriptor.
Member Function Documentation
◆ abortProcessing()
|
protected |
Attempts to abort the processing of the current item.
May be called only if isBusy() returns true and an assertion will remind you of that. Returns true if the abort request was successfully sent (but not necessarily handled by the slave) and false if the request couldn't be sent for some reason.
Definition at line 133 of file preprocessorinstance.cpp.
◆ currentProcessingTime()
|
protected |
Returns the time in seconds elapsed since the current item was submitted to the slave preprocessor instance.
If no item is currently being processed then this function returns -1;
Definition at line 124 of file preprocessorinstance.cpp.
◆ enqueueItem()
|
protected |
This is called by PreprocessorManager to enqueue a PimItem for processing by this preprocessor instance.
Definition at line 63 of file preprocessorinstance.cpp.
◆ id()
|
inlineprotected |
Returns the id of this preprocessor.
This is actually the AgentInstance identifier but it's not a requirement.
Definition at line 125 of file preprocessorinstance.h.
◆ init()
|
protected |
This is called by PreprocessorManager just after the construction in order to connect to the preprocessor instance via D-Bus.
In case of failure this object should be destroyed as it can't operate properly. The error message is printed via Tracer.
Definition at line 39 of file preprocessorinstance.cpp.
◆ invokeRestart()
|
protected |
Attempts to invoke the preprocessor slave restart via AgentManager.
This is the "last resort" action before starting to ignore the preprocessor (after it misbehaved).
Definition at line 153 of file preprocessorinstance.cpp.
◆ isBusy()
|
inlineprotected |
Returns true if this preprocessor instance is currently processing an item.
That is: if we have called "processItem()" on it and it hasn't emitted itemProcessed() yet.
Definition at line 109 of file preprocessorinstance.h.
◆ itemQueue()
|
inlineprotected |
Returns a pointer to the internal preprocessor instance item queue.
Don't mess with it unless you really know what you're doing. Use enqueueItem() to add an item to the queue. This method is provided to the PreprocessorManager to take over the item queue of a dying preprocessor.
The returned pointer is granted to be non null.
Definition at line 139 of file preprocessorinstance.h.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Nov 22 2024 12:03:34 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.